This is an Order Management System made for the assessment of the summer internship at Slash
- NestJs
- Prisma
- PostgreSQL
- Docker
- Swagger
- NPM
- NodeJs
- Docker
- clone the repository
git clone https://github.com/helloworld877/slash-asessment.git
- run
cd slash-asessment
- run
npm install
to install the node dependencies - then we run the setup script to launch a PostgreSQL Docker container, migrate the Prisma schema and populate the
Users
andProducts
tables (as Product and User creation were not requested in the requirements)- For Windows users
- run
./setup.ps1
- run
- For Linux users
- run
chmod +x setup.sh
then./setup.sh
- run
- For Windows users
- run
npm run start:dev
To see the documentation visit http://localhost:3000/api/ in your browser when the application is running
- install the "Thunder client" VScode extension
- go to the Thunder Client tab you can find it on the left (bottom icon)
- click on the icon and go to the collections tab and import the collection JSON (
thunder-collection_Slash Assessment.JSON
) found in the main directory of the repository
- After importing you will find pre-configured requests that you can edit to test the application
- To view the database you can connect to the database using PgAdmin 4
- the Database username is
root
and the password ispassword
- The application runs on port
3000
- The PostgreSQL docker container runs on port
5432
- Ensure that ports
3000
and5432
are open and have no apps running on them before running the project - to stop the docker container from running run
docker-compose down
- This will delete the container and the data will not persist