https://github.com/rpgeeganage/ts-coding-challenge-template
There are lots of layoffs around the world. (Including me). So this is a starter project for your next Take Home coding challenge. (Typescript + NodeJs)
https://github.com/rpgeeganage/ts-coding-challenge-template
coding-challenge coding-challenges coding-interviews interview-practice nodejs starter-template typescript
Last synced: 8 months ago
JSON representation
There are lots of layoffs around the world. (Including me). So this is a starter project for your next Take Home coding challenge. (Typescript + NodeJs)
- Host: GitHub
- URL: https://github.com/rpgeeganage/ts-coding-challenge-template
- Owner: rpgeeganage
- License: mit
- Created: 2023-01-20T12:23:14.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-07-20T05:09:18.000Z (over 2 years ago)
- Last Synced: 2025-02-28T23:21:17.341Z (about 1 year ago)
- Topics: coding-challenge, coding-challenges, coding-interviews, interview-practice, nodejs, starter-template, typescript
- Language: Dockerfile
- Homepage:
- Size: 756 KB
- Stars: 9
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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
```sh
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
```sh
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.