deine-Landschaft public API

This repository includes the source code of the official deine-Landschaft public API.

What is the public API?

The public api delivers the locations for deine-Landschaft as middleware from the backend.

Installation

Dev envioment

For this project you need to install these components:

• Git
• Node / NPM
• Any Editor (e.g. VS Codium)

⚠️ On mac you can use homebrew to install these components safely.

Setup

• Rename the .env.example to .env
• Please setup the global variables in the .env file.

Commands

npm install to install all npm components which needed.

npm run dev to run the development server.

On Windows

npm run dev-windows to run the development server.

License

This project use the GNU GPLv3. You can read it here