refactor(#74): change main framework to nest

Author: jog1t

.env

@@ -1,2 +1,4 @@
-PORT=4000
-HOST=http://localhost:
+DATABASE_URL="mysql://heroes:heroes@mysql/heroes"
+DATABASE_USER=heroes
+DATABASE_PASSWORD=heroes
+DATABASE_NAME=heroes

.env.example

@@ -1,3 +1 @@
-
-PORT=4000
-HOST=http://localhost:
+DATABASE_URL=

.eslintrc.js

@@ -0,0 +1,24 @@
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    project: 'tsconfig.json',
+    sourceType: 'module',
+  },
+  plugins: ['@typescript-eslint/eslint-plugin'],
+  extends: [
+    'plugin:@typescript-eslint/recommended',
+    'plugin:prettier/recommended',
+  ],
+  root: true,
+  env: {
+    node: true,
+    jest: true,
+  },
+  ignorePatterns: ['.eslintrc.js'],
+  rules: {
+    '@typescript-eslint/interface-name-prefix': 'off',
+    '@typescript-eslint/explicit-function-return-type': 'off',
+    '@typescript-eslint/explicit-module-boundary-types': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+  },
+};

.gitignore

@@ -1,6 +1,35 @@
-generated
-node_modules/
-schema-compiled.graphql
-src/.DS_Store
-.idea/
-.env
+# compiled output
+/dist
+/node_modules
+
+# Logs
+logs
+*.log
+npm-debug.log*
+pnpm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# OS
+.DS_Store
+
+# Tests
+/coverage
+/.nyc_output
+
+# IDEs and editors
+/.idea
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx --no -- commitlint --edit "$1"

.husky/pre-commit

@@ -0,0 +1,5 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npm run format
+npm run lint

.prettierrc

@@ -1,9 +1,4 @@
 {
-  "useTabs": false,
-  "printWidth": 80,
-  "tabWidth": 2,
   "singleQuote": true,
-  "trailingComma": "es5",
-  "jsxBracketSameLine": true,
-  "semi": true
-}
+  "trailingComma": "all"
+}

Dockerfile

@@ -0,0 +1,10 @@
+FROM node:14-alpine AS development
+
+WORKDIR /app
+
+COPY package.json /app/package.json
+COPY package-lock.json /app/package-lock.json
+
+RUN npm install
+
+EXPOSE 3000

README.md

@@ -57,7 +57,9 @@ Before you start, make sure you have [Docker](https://docs.docker.com/install/)
 
 ### Documentation
 
-Heroes API documention can be found [here](https://github.com/netguru/heroes-api/wiki).
+Documentation can be found, after initial setup, for HTTP in [Swagger](http://localhost:3000/swagger/#/), for GraphQL in [GraphQL Playground](http://localhost:3000/graphql).
+
+Old API documentation can be found [here](https://github.com/netguru/heroes-api/wiki).
 
 ### Initial setup
 
@@ -69,48 +71,34 @@ Heroes API documention can be found [here](https://github.com/netguru/heroes-api
   `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`
+   `docker compose up -d`
 
-4. Generate prisma instance based on datamodel.
-   `npm run generate`
+3. Open API container's terminal
+   `docker compose exec api /bin/sh`
 
-5. Deploy database schema into the MySQL database.
-   `npm run deploy`
+4. Deploy database schema into the MySQL database.
+   `npx prisma db push`
 
-6. Seed the database with default data.
-   `npm run seed`
+5. Seed the database with default data.
+   `npx prisma db seed`
 
 ### Running the project
 
-#### For REST API
-
-- Run in terminal:
-  `npm run start:rest`
-
-#### For GraphQL
-
-- Run in terminal
-  `npm run start:graphql`
+After the initial setup there's no additional work needed, project is running in the background as a Docker container.
 
-#### Important
+- The API is available on your local machine on `http://localhost:3000`.
+- Swagger documentation is available on `http://localhost:3000/swagger/`.
+- GraphQL playground is available on `http://localhost:3000/graphql`.
 
-- Deploy new schema (after modifying `datamodel.prisma`)
-  `prisma deploy`
+You can stop it by executing `docker compose stop`, and you can resume it by `docker compose start`
 
-- AFTER MODIFYING `prisma.yml`
-  `npm run generate`
 
 <!-- Authors -->
 
 ## Authors
 
-1. <a href="https://github.com/qmixi" target="_blank">Piotr Kumorek</a>
-2. <a href="https://github.com/SebastianStj" target="_blank">Sebastian Stój</a>
-3. <a href="https://github.com/slawomirkolodziej" target="_blank">Sławek Kołodziej</a>
-4. <a href="https://github.com/Kamieniu" target="_blank">Franciszek Stodulski</a>
+1. <a href="https://github.com/serrg" target="_blank">Sergiusz Strumiński</a>
+2. <a href="https://github.com/jog1t" target="_blank">Kacper Wojciechowski</a>
 
 <!-- LICENSE -->
 

datamodel/avatar.prisma

@@ -1,28 +1,39 @@
-version: '3'
+version: '3.4'
 services:
-  prisma:
-    image: prismagraphql/prisma:1.34
-    restart: always
-    depends_on:
-      - mysql
-    ports:
-      - '4466:4466'
-    environment:
-      PRISMA_CONFIG: |
-        port: 4466
-        databases:
-          default:
-            connector: mysql
-            host: mysql
-            port: 3306
-            user: root
-            password: prisma
   mysql:
-    image: mysql:5.7
+    platform: linux/x86_64
+    image: mysql:8
     restart: always
     environment:
-      MYSQL_ROOT_PASSWORD: prisma
+      MYSQL_RANDOM_ROOT_PASSWORD: 'yes'
+      MYSQL_USER: $DATABASE_USER
+      MYSQL_PASSWORD: $DATABASE_PASSWORD
+      MYSQL_DATABASE: $DATABASE_NAME
     volumes:
       - mysql:/var/lib/mysql
+
+  api:
+    platform: linux/x86_64
+    build:
+      dockerfile: Dockerfile
+      context: .
+      target: development
+    command: npm run start:dev
+    environment:
+      DATABASE_URL: $DATABASE_URL
+    volumes:
+      - .:/app
+      - /app/node_modules/
+    depends_on:
+      - mysql
+    ports:
+      - "3000:3000"
+
+  adminer:
+    image: adminer
+    restart: always
+    ports:
+      - "8080:8080"
+
 volumes:
   mysql: ~

datamodel/hero.prisma

@@ -0,0 +1,4 @@
+{
+  "collection": "@nestjs/schematics",
+  "sourceRoot": "src"
+}