Skip to content

Latest commit

 

History

History
86 lines (54 loc) · 1.87 KB

ReadMe.md

File metadata and controls

86 lines (54 loc) · 1.87 KB
Raw

Note API routes will soon be added to the wiki

FlareHTTP

An open source MVC project

Features

  • HTTP requests handles by ExpressJS
  • Data stored in Cloud Firestore
  • IBANs are the document id which makes requesting data easier
  • Code uses a service account key instead of database secrets

Prerequisites

Node NPM Docker

Note Although not tested, higher or lower versions may work.

Authors

Environment Variables

To run this project, you will need to add the following environment variables to your .env file

EXPRESS_IP={ip}, EXPRESS_PORT={port} VIEW_ENABLED={true||false} API_ENABLED={true||false}

If you deploy the project make sure the EXPRESS_PORT matches the port of the container. The value of EXPRESS_IP is recommended to be set to 127.0.0.1 if you dont know the ip.

Run Locally

Warning Only follow these instructions if you plan to edit it. Please follow 'Deployment' when you want to use this in a production environment

Clone the project

  git clone https://github.com/RFlintstone/FlareHTTP.git FlareHTTP

Go to the project directory

  cd FlareHTTP

Install dependencies

  npm i

Start the development environment

  npm start

Deployment

To deploy this project run.

docker run -d --name flarehttp -p 80:8080 -e NODE_ENV=production ghcr.io/rflintstone/flarehttp:main

If you don't already have the image on your machine it will pull the latest version from the repo.

Roadmap

https://github.com/users/RFlintstone/projects/2/

Used By

This project is used by:

  • Group 14, Project 3/4 2023 - Rotterdam University of Applied Sciences