Sports Markers API

Backend of Sports Markers.

Demo

This API is deployed in Railway: See demo.

Endpoints

Installation

To use the project locally:

  1. Clone the repository on your local machine:
git clone https://github.com/EudesSerpa/sports-markers
  1. Change directory:
cd sports-markers
  1. Install the dependencies:
npm install
  1. Start the application:
npm run dev

Considerations

This project needs environment variables. See the ".env.example" file for the variables used.

Usage

Once the application is running, you can view it from your browser at http://localhost:3000/api/v1/[endpoint].