A StoreFront backend application written in NodeJS and Typescript as a part of FullStack Javascript Nanodegree program. This application has APIs for Users, Products, and Orders and their respective CRUD operations.

You need the following modules and dependencies installed to run this project:

docker-compose   # To run the Postgres database on Docker
Node v14.16.0    # To run the application
Typescript       # App is written in Typescript
yarn             # For dependency management

Simply, run the following command to install the project dependencies after you have cloned the repository:

yarn

POSTGRES_HOST = 127.0.0.1

    POSTGRES_DB = storefront_db
    POSTGRES_USER = tauseef_ahmed
    POSTGRES_PASSWORD = password123

    POSTGRES_TEST_DB = storefront_db_test
    POSTGRES_TEST_USER = tauseef_ahmed_test
    POSTGRES_TEST_PASSWORD = password123

Please check REQUIREMENTS.md for Database related info.

Use the following command to run the application:

yarn start

The application will run on http://localhost:8000/.

The application runs on PORT 8000

Use the following command to run the unit tests:

yarn test

yarn lint

You may also use the Postman collection present in the repository for testing.

• NodeJS - The JavaScript runtime
• Yarn - The dependency manager
• db-migrate - The database migration tool
• Express - The web framework
• TypeScript - Types JS extension
• Jasmine - The unit testing framework

Toseef Ahmed