Anime Runner's API

Simple application in NestJS to record your longest time alive in a match at Anime Runner's.

About The Project

Em complemento ao jogo Anime Runner's, feito na Unreal Engine 4.27, que é um jogo onde o objetivo é sobreviver o maior tempo possível, veio a ideia de registrar esse tempo de cada jogador e salvar em um banco de dados, assim sendo possível fazer um ranking de cada um.

Built With

• Node v19.3.0
• Typescript v4.7.4
• NestJS v9.0.0
• Prisma v4.8.0

Getting Started

For the use of the project, some prerequisites will be necessary.

Prerequisites

• Node.JS
  1. You can download here: Node.JS
  2. Here is a step-by-step installation tutorial. (Windows) (Linux)

.env variables

You need to create an .env file inside the project root. You can also create .env.development and .env.production.

API_KEY="key"
SWAGGER="TRUE"
DATABASE_URL="postgres://user:password@..."

Installation

1. Clone the repository

   git clone https://github.com/Arekushi/anime-runners-api.git

2. Install NPM packages

   npm install

3. Run in terminal

   npm run build

4. Start application

   npm run start:prod

5. All ready, the application is already running 🎉

Roadmap

• Creating models in Prisma
• Ranking Module
  • Matches Service
  • Matches Controller
• Test

Schema

You can see the generated schema below. Generated by dbdiagram.io platform

Acknowledgments

• Add header API key auth to your NestJS REST API
• How To Implement Passport.js in Nest.js: An Easy Tutorial
• Nest.js — Authenticate with both API Key and JWT

Contributors

Alexandre Ferreira de Lima 💻