allan-gilber / labenu-system

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

LabenuSystem - A API for School Data Management

API created for storing and processing a fictional programming school.

Utilized languages/techonologies:

Prerequisites:

To run the project you will need to have installed the following tools: Gitbash, Node.js, Typescript and VSCode(or similar IDE).

How to run the project with Gitbash:

# Clone the repository:
$ git clone https://github.com/allan-gilber/backend-challenge-2022-covid-daily-cases.git

# Run gitbash on the folder that was created
$ cd ./labenu-system

# Install the necessary dependencies with:
$ npm i

# Config your local variables in a .env file in the root directory of the project 
# so you can connect to your MYSQL database(more info below)
# After configuring the access, run the script to create and populate your DB:

$ npm run migration

# To start the project use the following command:

$ npm start

# The server will start on the configured port in the .env file or the default "3003".

.ENV - IMPORTANT

Don't forget to config the local variables in a ".env" file located in the root folder of the project. Just create a new file named ".env" and insert the following text, substituting with your information:

DB_HOST = (link to your host)
DB_USER = (user)
DB_PASSWORD = (password)
DB_SCHEMA = (database/schema)

API documentation

All information on how to use the API can be found here.

About


Languages

Language:TypeScript 100.0%