DISTRO WEB

A distribution web client that helps users in food distribution & medical camps

Pre-requisites

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

Getting Started

To get started, clone the repository and install the dependencies:

git clone git@github.com:Mradi-Kenya/distro-web.git
cd distro-web
npm install

To start the development server, run:

npm run dev

Then visit http://localhost:3000 to view the app.

Formatting and Linting

This project uses Prettier for formatting and ESLint for linting. To format your code, run:

npm run prettier

To lint your code, run:

npm run lint

Note: Prefix variables with an underscore_ if you have declared them but not used them. e.g. const _variable = 'value';

Git Hooks

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.

Storybook

This project uses Storybook to document and develop components in isolation. To start storybook, run:

npm run storybook

Then visit http://localhost:6006 to view the storybook.