Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in
Toggle navigation
Menu
Open sidebar
protokollsystem
proto3
Commits
9d26a939
Commit
9d26a939
authored
Feb 17, 2018
by
Robin Sonnabend
Browse files
Add development setup guide
parent
022d3bb0
Changes
2
Hide whitespace changes
Inline
Side-by-side
DEVELOPMENT.md
0 → 100644
View file @
9d26a939
# Development Guide
## Setup
*
Install python3 and virtualenv
*
Create a virtualenv and install the requirements
```
virtualenv -p python3 venv
source venv/bin/activate
pip install -r requirements.txt
```
*
Create a database (with sqlite, postgres, …)
*
Create a config file
```
cp config.py.example config.py
```
*
Edit the config file to your needs
-
Don't forget to enter your database connection
-
And your authentication backend
-
And deactivate everything you do not use
*
Fill your database
```
./server.py db upgrade
```
## Running the program
```
source venv/bin/activate
./server.py runserver
```
The website will run on
`localhost:5000`
.
config.py.example
View file @
9d26a939
# (local) database
SQLALCHEMY_DATABASE_URI = "postgresql://user:password@host/database" # change this
#SQLALCHEMY_DATABASE_URI = "mysql://user:password@host/database"
#SQLALCHEMY_DATABASE_URI = "sqlite:///path/to/database.db"
SQLALCHEMY_TRACK_MODIFICATIONS = False # do not change
SECRET_KEY = "something random" # change this
...
...
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment