README.md

Machbarschaft-Frontend

ReactJS Frontend for Machbarschaft

Prerequisites

The application requires NodeJS and npm as package manager

• nodejs - nodejs includes
• npm (node package manager)

IMPORTANT Get a local API (backend) up and running as described here: Machbarschaft API Project Also activate Geocoding and Maps JavaScript API as well as the billing in the google cloud account

Setup

Enviroment File

Create a .env file and fill it as shown in the .env.example file and below

# 'local' utilizes a local database, 'api-sta' points to our staging environment
API_URL_SUB=local
# The next two keys could be the same
FIREBASE_API_KEY=
MAPS_API_KEY=
PROJECT_ID=

Dependencies

Install the required dependencies with npm

npm install

Local Development

The local development version starts by

npm start

The backend ist expected to run at http://localhost:8080

Production Code

The code for staging or production resides in dist directory after it builds by running the command as follows:

npm build

The backend runs at (staging or production):

STA: https://api-sta.machbarschaft.jetzt/v1/
PRD: https://api.machbarschaft.jetzt/v1/

GitHub actions build the code, run tests and deploy it to the respective environments. For more information please review the workflow file in .github/workflows