Skip to content

Commit 1ded098

Browse files
restructured docs
1 parent d1c38f1 commit 1ded098

File tree

2 files changed

+19
-0
lines changed

2 files changed

+19
-0
lines changed

docs/source/deployment_overview.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Deployment Overview
2+
3+
The MapSwipe Back-End is deployed using Docker.
4+
Every part of the back-end has a Dockerfile.
5+
All parts/ Dockerfiles come together in the docker-compose file.
6+
7+
To setup the whole ecosystem of MapSwipe Workers it is easier to first make sure every part is configured and all keys are in place.
8+
9+
MapSwipe utilizes a bunch of Google Cloud services:
10+
11+
- [Firebase](https://firebase.google.com/) project with Realtime Database and Functions
12+
- Create a project
13+
- Create a database: `> Develop > Database > Create Database`
14+
- [Google Cloud Storage](https://cloud.google.com/storage/) for backup of Postgres
15+
16+
[Configuration and Credentials]() describes all needed configuration and credentials.
17+
18+
[Installation]() describes step-by-step how to setup the backend for the first time.

docs/source/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ Welcome to MapSwipe Back-End's documentation!
2626
:maxdepth: 2
2727
:caption: Deployment:
2828

29+
deployment_overview
2930
configuration
3031
installation
3132
tutorials

0 commit comments

Comments
 (0)