Heroes API

A backend application built with Prisma, Docker and NestJS
Report Bug · Request Feature

Table of Contents

• Table of Contents
• Stack
• Getting Started
  • Documentation
  • Initial setup
  • Running the project
• Authors
• License

Stack

This application was built with:

• NestJS
• Prisma
• Node.js
• Docker

Getting Started

Before you start, make sure you have Docker and Node installed on your local machine.

Documentation

Documentation can be found, after initial setup, for HTTP in Swagger, for GraphQL in GraphQL Playground.

Initial setup

1. Clone this repo into your local machine

• with https
  git clone https://github.com/netguru/heroes-api.git
• or with ssh
  git clone [email protected]:netguru/heroes-api.git

2. Launch Docker compose to run Prisma's and MySQL's images. docker compose up -d

3. Open API container's terminal docker compose exec api /bin/sh

4. Deploy database schema into the MySQL database. npx prisma db push

5. Seed the database with default data. npx prisma db seed

Running the project

After the initial setup there's no additional work needed, project is running in the background as a Docker container.

• The REST API is available on your local machine on http://localhost:3000.
• Swagger documentation is available on http://localhost:3000/swagger/.
• GraphQL playground (and server) is available on http://localhost:3000/graphql.

You can stop it by executing docker compose stop, and you can resume it by docker compose start

Authors

1. Sergiusz Strumiński
2. Kacper Wojciechowski

License

Distributed under the MIT License. See LICENSE for more information.