iranbrg/madclothes-api

RESTful API for controlling sales of clothing items in a clothes shop called Madclothes.

madclothes-api

About The Project

It is a RESTful API for controlling sales of clothing items in a clothes shop called Madclothes. The goals are using it to study backend development, with the stack informed below, and build a portfolio.

Tech Stack

• Typescript
• Node.js
• Express.js
• TypeORM
• PostgreSQL
• Jest
• GitHub Actions
• Docker
• Heroku

How To Run The Project

Clone The Repository

$ git clone https://github.com/iranbrg/madclothes-api.git
$ cd madclothes-api

Install Dependencies

$ npm install

Set Enviroment Variables

Create a .env file in the project's root. Check .env.example to see what needs to be set.

$ cp .env.example .env
$ vim .env

Setup Containers With docker-compose

$ docker-compose up -d

Run Migrations

$ npm run typeorm migration:run

Run The Server For Development

$ npm run dev

Project Progress

In the main branch, one can use the stable version of this API whereas in the staging branch are the latest and more updated features.

This project is deployed on Heroku and any client can consume this API. So checkout:

• Staging
• Production

To check the current project's stage and the plans for new features, see TODO.md

Documentation

The documentation for this API can be found here

A Potman Collection is also available at docs directory