Skip to content

AthletX-org/athletx-server

Repository files navigation

AthletX Web Server

Repository for AthletX Web Server.
The Server is made with Node Js, Express Js and MongoDB as database.

Documentation

Check out the REST-API of the Server on the dedicated website.

Usage

To run the server in localhost:

  1. Clone the server repository:
    git clone https://github.com/AthletX-org/athletx-server.git
  2. Provide a .env file in the root of the project with the following variables:
    • mongodb_connection_string: the connection string of your mongodb instance
    • jwtKey: a unique key used to generate Json Web Tokens to authenticate users
    • jwtDuration: the duration of the generated tokens (ex: 30d)
  3. Run the following command:
    node src/app.js
  4. The server will be accessible at http://localhost:3000