A distribution web client that helps users in food distribution & medical camps
Before getting started, make sure you have the following installed on your machine:
- Node.js(v18.15.0 or higher)
- Npm(v9.5.0 or higher)
- Typescript
To get started, clone the repository and install the dependencies:
git clone [email protected]:Mradi-Kenya/distro-web.git
cd distro-web
npm installTo start the development server, run:
npm run devThen visit http://localhost:3000 to view the app.
This project uses Prettier for formatting and ESLint for linting. To format your code, run:
npm run prettierTo lint your code, run:
npm run lintNote: Prefix variables with an underscore_ if you have declared them but not used them. e.g. const _variable = 'value';
This project uses Husky to run git hooks. The following hooks are configured:
- pre-commit: Runs linting on staged files
- pre-push: Runs a build to ensure the code compiles
We also use commitlint to ensure that commit messages follow the Conventional Commits specification.
Check out commitlint.config.js for the configuration.
This project uses Storybook to document and develop components in isolation. To start storybook, run:
npm run storybookThen visit http://localhost:6006 to view the storybook.