• About the Project
  • Tech Stack
  • Environment Variables
• Getting Started
  • Prerequisites
  • Run Locally
• License
• Acknowledgements

To run this project, you can create a .env configuration file using template.env as a guide

This project uses NPM as package manager

Clone the project

  git clone https://github.com/danimr99/openevents-api.git

Go to the project directory

  cd openevents-api

Configure database using SQL code

Install dependencies

 npm install

Start the server in development environment

  npm run dev

Transpile TypeScript to JavaScript (it will generate build folder on the root directory of the project)

  npm run build

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

Useful resources and libraries:

• OpenAPI
• TypeScript
• Express
• Node JS
• @sideway/address
• bcrypt
• dotenv
• helmet
• jsonwebtoken
• morgan
• mysql2