After pulling the repository please add the .env
file in the root directory based on .env.example
with the correct environment variables.
-
npm i
for install node modules -
npm run start:dev
for development environment -
npm run start:prod
for production environment -
npm run build
for build codes
The API will be run on port 3000. For sending a response to the API use the following URL
Local http://localhost:3331
Deployed http://52.91.18.50:3000
The documentation of API You can see Local http://localhost:3331/api-doc Deployed http://52.91.18.50:3000/api-doc
-
Clone repository
-
Commands to run
make up ENV=dev
for dev environmentmake up ENV=prod
for prod environment -
Commands to disable
make down ENV=dev
for dev environmentmake down ENV=prod
for prod environment -
For connecting to containers
make exec_api ENV=dev
ordocker exec -it contacts-api-dev /bin/bash
make exec_api ENV=prod
ordocker exec -it contacts-api-prod /bin/bash
-
git fetch
-
git pull
-
make up ENV=dev
for dev environment -
make up ENV=prod
for prod environment