Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a Develop section in README #47

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add a Develop section in README #47

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,34 @@ Fell free to:

Translations can be done in transifex: https://www.transifex.com/openstreetmap/osm-streak/

## Develop ##

Prerequisites: a Linux OS or Mac OS since ruamel.yaml does not support emoji on Windows.

Install requirements:
`pip install -r requirements.txt`

Run the app:
`./run.py`

### Add your account in streak.db ###

For tests purpose only, you can manualy add your account in the streak.db database:
1. Open streak.db with sqlitebrowser or similar application
2. Add a line in the user table:
* uid: your OSM uid. You can use http://whosthat.osmz.ru to get it
* name: your OSM login
* email: your email
* lang: your language code
* set score, streak and level to 0

### Create a new challenge ###

Create a new file in folder tasks. Have a look to other tasks to understand the syntax.

Then you can test a changeset against all the tasks with following command:
`./test_chargement.py`

## License ##

OSM Streak is released under the MIT license