andresaaap / store-api-typescript

RESTful API to browse an index of all products and add products to an order. Stack: express, typescript, node

Storefront Backend Project

Project Title

A brief description of what this project does and who it's for

Pre-requisites

• Docker. Install Docker
• Docker Compose. Install Docker Compose
• Node. Install Node
• db-migrate. Install the global package npm install -g db-migrate

Run Locally

Clone the project

  https://github.com/andresaaap/store-api-typescript

Go to the project directory

  cd <project-directory>

Install dependencies

  npm install

Start the database using docker-compose

  docker-compose up -d

Make sure that you installed db-migrate globally. If not, run the following command

  npm install -g db-migrate

Run the migrations

  db-migrate up -e dev

It is possible that you need to run the command serveral times until all of the tables are created.

Build the project

  npm run build

Create a .env file in the root directory and add the following variables

POSTGRES_HOST=127.0.0.1
POSTGRES_DB=postgres
POSTGRES_USER=postgres
POSTGRES_PASSWORD=mypass
POSTGRES_DB_TEST=postgres_test
ENV=dev
POSTGRES_DB_PORT=5432
BCRYPT_PASSWORD=felipe-andres
SALT_ROUNDS=10
TOKEN_SECRET=secret
PORT=3000

Run project, which will start the server in port 3000 and the database in port 5432

  npm run start

Tech Stack

Server: Node, Express, jsonwebtoken, bcrypt, jasmine, jsonwebtoken, supertest

Running Tests

Start the database using docker-compose

  docker-compose up -d

Make sure that you installed db-migrate globally. If not, run the following command

  npm install -g db-migrate

Make sure that the postgres-test database doesn't exist. If it does, drop it.

  db-migrate db:drop postgres_test

Create a .env file in the root directory and add the following variables

POSTGRES_HOST=127.0.0.1
POSTGRES_DB=postgres
POSTGRES_USER=postgres
POSTGRES_PASSWORD=mypass
POSTGRES_DB_TEST=postgres_test
ENV=dev
POSTGRES_DB_PORT=5432
BCRYPT_PASSWORD=felipe-andres
SALT_ROUNDS=10
TOKEN_SECRET=secret
PORT=3000

To run tests, run the following command

  npm run test

Usage/Examples

The following demo shows how to use the API and run the tests

Demo 🎥