flagoon / heroes-api

Heroes API

A backend appliaction built with Prisma, Docker and Node.js
Explore the docs »

Report Bug · Request Feature

Table of Contents

• Table of Contents
• Built With
• Getting Started
  • Initial setup
  • Running the project
    • For REST API
    • For GraphQL
    • Important
• Authors
• License

Built With

This application was built with:

• Prisma
• Node.js
• Docker

Getting Started

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

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. Install all the dependencies. npm install

4. Generate prisma instance based on datamodel. npm run generate

5. Deploy database schema into the MySQL database. npm run deploy

6. Seed the database with default data. npm run seed

Running the project

For REST API

• Run in terminal: npm run start:rest

For GraphQL

• Run in terminal npm run start:graphql

Important

• Deploy new schema (after modifying datamodel.prisma) prisma deploy

• AFTER MODIFYING prisma.yml npm run generate

Authors

1. Piotr Kumorek
2. Sebastian Stój
3. Sławek Kołodziej
4. Franciszek Stodulski

License

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