The application uses Nestjs framework to perform different operations on category, subcategory, items for e commerce applications.
www_screencapture_com_2024-5-19_10_32.mp4
The project uses the following tools.
Nest JS framework: A progressive backend framework built on top of Node JS.mongoose: A node js based library to interact with mongo db database.mongodb: A popular Nosql database. [compass for initial testing, recommended to use mongodb atlas]Husky: To configure precommit hooks, consistent commits etc.Ci Cd pipleine: Automated workflow using github actions/workflow.Prettier and eslint configurations: Tool to configure the codes and make it consistent.yarn package maanger: A package manager with better performance compared to npm.docker: Docker is a containerization platform to deploy software applications.
-
First clone the repository:
git clone https://github.com/asifrahaman13/dreamer-dolphin.git -
Next move on to the dreamer dolphin repository.
cd dreamer-dolphin/ -
Next install the dependencies.
$ yarn install
create an env variable file.
mv .env.example .env
$ yarn run start
$ yarn run start:dev
$ yarn run start:prod
- Follow the steps in case you want to run the application as a docker container:
docker build -t dreamer-dolphin:latest . - Rn the docker container:
docker run -p 5000:5000 dreamer-dolphin:latest
Note: Please use mongodb atlas in case you are running on docker container. Using local host may throw erro in that case.