Subway System Challenge

A project that provides a basic implementation of a subway network. It includes classes for stations, lines, and a subway system that can be used to model and navigate through a subway system. The code is written in NestJS (Typescript + Node.js) and can be used as a starting point for more complex subway system projects.

🔧 Prerequisite

To bring up the application, you MUST first:

• Clone the repository
  • git clone git@github.com:wenderpmachado/subway-system.git
• Install the dependencies
  • yarn install or npm install
• Set the environment variables
  • Renaming the .env.example file to .env
  • Fill in the secret information

Installation

$ npm install

Running the app

# development
$ npm run docker:up:local

The API will be available at http://localhost:3000/

And the Swagger at http://localhost:3000/api

Exploring and manipulating the database

# development
$ npm run prisma:studio

The manager will be available at http://localhost:5555/

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

📕

Released in 2022 Made by Wender Machado 🚀