Skip to content

beckn/beckn-ui-workspace

Folders and files

NameName
Last commit message
Last commit date
Dec 10, 2024
May 10, 2024
Jun 28, 2024
Sep 11, 2023
Dec 11, 2024
Dec 9, 2024
Dec 11, 2024
Dec 9, 2024
Jun 12, 2024
Sep 10, 2023
Sep 10, 2023
Mar 6, 2024
Sep 10, 2023
Aug 12, 2024
Sep 27, 2023
Sep 11, 2023
Sep 11, 2023
Sep 11, 2023
Sep 19, 2024
Apr 5, 2024
Oct 28, 2024
Jun 20, 2024
Jun 20, 2024
Oct 5, 2023
Nov 19, 2024
Jul 19, 2024
Dec 4, 2024

Repository files navigation

Beckn-ui-workspace

Description

Beckn-ui-workspace is a monorepo consisting of all Beckn possible frontend use-cases and BAPs.

Installation and Usage

  1. Use specific node version: First install nvm on your local machine and then run the below commad to ensure accurate node version. This will automatically switch the node version.

    nvm use
  2. Install Dependencies: To get started, run the following command in the root of the repository to install all the required modules using Yarn:

    yarn
  3. Running Individual Projects: Each sub-project can be run individually by executing their specific commands. You can find these commands in the package.json file located in the root directory.

Configurations

This monorepo is globally configured with the following tools and libraries:

  1. Yarn Workspace: Used for creating and managing sub-projects within the monorepo.

  2. Typescript: Provides robust type checking and enhances code quality.

  3. Jest: Utilized for unit testing, ensuring the reliability of the codebase.

  4. Prettier and ESLint: These tools are used for code formatting and style consistency, ensuring a clean and readable codebase.

  5. Husky: Sets up commit hooks to run on both commit and pre-commit actions, helping maintain code quality and enforcing best practices.

  6. Commit-lint: Enforces a structured commit message format. Please refer to the Conventional Commits documentation for commit message conventions.

Feel free to explore and contribute to the various front-end use cases and BAPs within this monorepo. If you have any questions or need any more help, please refer to the individual project documentation or reach out to the repository maintainers.

Happy coding!