README.md

A starter project for your next Take Home coding challenge. (Typescript + Nodejs)

(Since there are lot of layoffs around the world)

for your information

You can use this with Docker.

Packages already included are as follows.

1. Express
2. ZOD
3. Axios
4. Jest
5. Supertest
6. ESlint
7. Prettier
8. Husky

Config

• This repo has predefined config file ./src/configs.ts.
• It uses zod library to validate schema. (https://zod.dev/)

Path Alias

• This project support path alias in TypeScript.
• So you can import files as follows.

import { Configs } from 'src/configs';

console.log(Config.PORT);

npm commands

npm i               # install packages
npm run build       # Build project
npm t               # Run tests
npm start           # Run the app.
npm run lint        # Run lint
npm run fix:lint    # Fix lint issues

Make file

make install    # Install dependencies
make up         # Run service
make upd        # Run service in the background
make cmd        # Run the service and connect to the `bash`
make down       # Tear down the service
make clean      # Clean containers in `exited` status.

Pre commit hook

• Run chmod +x ./husky/pre-commit to enable pre commit hook.