Beckn-ui-workspace is a monorepo consisting of all Beckn possible frontend use-cases and BAPs.
-
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
-
Install Dependencies: To get started, run the following command in the root of the repository to install all the required modules using Yarn:
yarn
-
Running Individual Projects: Each sub-project can be run individually by executing their specific commands. You can find these commands in the
package.jsonfile located in the root directory.
This monorepo is globally configured with the following tools and libraries:
-
Yarn Workspace: Used for creating and managing sub-projects within the monorepo.
-
Typescript: Provides robust type checking and enhances code quality.
-
Jest: Utilized for unit testing, ensuring the reliability of the codebase.
-
Prettier and ESLint: These tools are used for code formatting and style consistency, ensuring a clean and readable codebase.
-
Husky: Sets up commit hooks to run on both commit and pre-commit actions, helping maintain code quality and enforcing best practices.
-
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 further assistance, please refer to the individual project documentation or reach out to the repository maintainers. Happy coding!