Giter Club home page Giter Club logo

slash-asessment's Introduction

Order Management System

Description

This is an Order Management System made for the assessment of the summer internship at Slash

Technology Stack

  • NestJs
  • Prisma
  • PostgreSQL
  • Docker
  • Swagger

Dependencies

  • NPM
  • NodeJs
  • Docker

Setting Up

  • 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 and Products tables (as Product and User creation were not requested in the requirements)
    • For Windows users
      • run ./setup.ps1
    • For Linux users
      • run chmod +x setup.sh then ./setup.sh
  • run npm run start:dev

Documentation

To see the documentation visit http://localhost:3000/api/ in your browser when the application is running

Testing

  • install the "Thunder client" VScode extension
  • go to the Thunder Client tab you can find it on the left (bottom icon)

image

  • 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

image

  • After importing you will find pre-configured requests that you can edit to test the application

image

Notes

  • To view the database you can connect to the database using PgAdmin 4
  • the Database username is root and the password is password
  • The application runs on port 3000
  • The PostgreSQL docker container runs on port 5432
  • Ensure that ports 3000 and 5432 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

slash-asessment's People

Contributors

helloworld877 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.