Skip to content
This repository has been archived by the owner on Jul 3, 2022. It is now read-only.
/ API Public archive

The API for interacting with vehicle data

Notifications You must be signed in to change notification settings

DylanGore-FYP/API

Repository files navigation

API

All Contributors

GitHub Workflow Status - Lint GitHub Workflow Status - Build

Requirments

  • Node JS v14+

Configuration

A Firebase service account file is required for this software to run. Please see the documentation for details. Other than that please create a .env file based on the example found in this repository. If you would like to run this app in Docker, please see the docker-compose.yml file for an example.

Running

Install the dependencies:

npm install

Run the development server:

npm run server-dev

Run the production server:

npm run production

Commit Message Convention

This project uses Gitmoji for commit organisation. For more details see the Gitmoji Repository.

Contributors


Dylan Gore

💻 📖 🤔

Mohit Taneja

🤔

This project follows the all-contributors specification.