BilalDja / white-belt

Boiletplate Express typescript repository

White belt

Express typescript boilerplate project that gives you a boost and a nice workflow.

Usage

mkdir yourProject
cd yourProject
git clone https://github.com/BilalDja/white-belt .
yarn

or

npm install

After downloading the project dependencies, you have to add .env file that holds your environment variables. To do that through the terminal:

cp .env.example .env

Then edit your .env file according to your needs

Whenever you change the .env file either by adding or removing a variable please run:

yarn gen-env

or

npm run gen-env

That will update your .env.example and src/types/env.d.ts files.

Testing

This project runs tests programmatically, so whenever you add a new test file you need to insert it in tests/subtests.ts file. This project runs tests using mocha test framework, and chai assertion library. To run the tests use: yarn test or npm test.

Any suggestions are welcome, or you can add a PR (Pull request)