This boiler plate repository shows some general features I usually implement in my express + TypeScript projects.
- Clone the repo
- Setup commit message interface by running
git config --local commit.template .gitmessage
- Add the env variables using .env.example
You can run Redis in your machine easily via:
docker run -p [PORT_HERE]:[PORT_IN_DOCKER_HERE] redis
eg
docker run -p 6379:6379 redis
-
Ensure you have Docker installed and running on your machine
-
Build and tag the docker image
docker build -t <tag> -f Docker/Dockerfile .
eg
docker build -t express_boiler -f Docker/Dockerfile .
- Spin up the container
docker run -d --name <container name> -p <port-in-.env>:<port-in-.env> <tag>:latest
eg
docker run --name express_boiler_container -p 4000:4000 express_boiler:latest
- The above command should return a container ID, to stop a running container
docker stop <containerID>
OR
docker stop <container name>
This boilerplate handles all the authentication-related endpoints including:
- Login
- Register
- Reset Password
- Forgot Password
You can access the documentation of these endpoints in this Postman Documentation or download run in
You may also decide to download the docs from the docs folder in the repository.