This template uses:
- Typescript
- Prisma
- NodeJS
- Express
- Postgres
- ESLint
- Swagger
Make sure you have node and docker installed by typing node -v
and docker -v
in terminal.
- Use the repository as template (by forking it or using this one directly)
- Install dependencies
yarn
- Run
docker run -d --name postgres -e POSTGRES_PASSWORD=mypass -e -p 5432:5432 postgres:latest
- Create a database in your container
- Configure
.env
file copying the .env.example and setting the variables
-
yarn dev:server
: starts the server in the port you specified in .env (default 3333) -
yarn prisma
: enables prisma cli -
yarn lint
: check linting rules based in the .eslintrc.json file -
yarn build
: transpile the src directory
Don't forget to check if the template features fits your use case!
Check for the .github/workflows files, because they will need to be updated once you start your deploy