Skip to content

Commit 5d45f9d

Browse files
committed
work on docs
1 parent 08ae193 commit 5d45f9d

File tree

2 files changed

+13
-0
lines changed

2 files changed

+13
-0
lines changed

docs/source/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ Welcome to MapSwipe Back-End's documentation!
2828

2929
configuration
3030
installation
31+
tutorials
3132
updating
3233
testing
3334
debugging

docs/source/tutorials.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,18 @@
11
# Tutorials
22
For each project type there should be at least one tutorial. Tutorials are similar to actual projects. To display the tutorial we will use the same design and screens as if a user would map for real.
33

4+
## Deploy tutorials to Firebase Database from Docker
5+
You can upload tutorial data to Firebase like this:
6+
7+
```bash
8+
docker run --name mapswipe_workers_local -it pythonmapswipeworkers_mapswipe_workers bash`
9+
mapswipe_workers --verbose create-tutorial --input_file=sample_data/build_area_tutorial.json
10+
exit
11+
docker rm mapswipe_workers_local
12+
```
13+
14+
If you want to use a customized tutorial make sure to adjust the `.json` file in the sample data folder and also add the file for the tasks.
15+
416
## Data Perspective
517
Tutorials and projects have the following in common:
618
* both have groups with the same structure (there can also be several groups per tutorial)

0 commit comments

Comments
 (0)