/TTBackend

Primary LanguageJavaScript

Table Tennis Hub Backend (TTBackend)

This is a simple backend for the Table Tennis Hub project. (This project is still in development)

Getting Started

Prerequisites

Be sure to have the following installed on your system:

  • Node.js
  • MySQL (or a MySQL server)
  • Yarn (optional - if you prefer to use NPM, you can skip this step and use NPM instead of Yarn)

Installation

  1. Clone the repository
git clone https://github.com/Toukara/TTBackend
  1. Install dependencies
yarn install
  1. Create a .env file in the root directory of the project and fill it with the following information:
# Database
DB_HOST = # Host Database
DB_PORT = # Port Database
DB_DATABASE = # Database Name
DB_USERNAME = # Database Username
DB_PASSWORD = # Database Password

Usage

  1. Start the server
yarn start
  1. Go to http://localhost:1000 to see the API documentation

Built With

Express The web framework used
Sequelize The ORM used
MySQL The database used