An open API service indexing awesome lists of open source software.

https://github.com/marknjunge/globalgym-api

Backend API for GlobalGym
https://github.com/marknjunge/globalgym-api

Last synced: over 1 year ago
JSON representation

Backend API for GlobalGym

Awesome Lists containing this project

README

          

# GlobalGym API

GlobalGym is an app that allows users to access any member gym across Africa.

See Android app: [Global Gym - Android](https://github.com/MarkNjunge/GlobalGym-Android)

**NB: GlobalGym was created as a school project. It is not used in production.**

## Requirements

1. NodeJS
2. MongoDB

## Installation

1. Clone the repisotry using `https://github.com/MarkNjunge/GlobalGym-api.git`.
2. Create a `.env` file in the root folder sililar to `.env.sample`.
3. Install dependencies using `yarn`.

## Usage

Start the api using `yarn start` or `yarn server` for a live reloading version (requires nodemon).

## Documentation

**Needs updating**