A project organisation tool built with Flask. A deployed version can be viewed here.
TODO
The following properties can be configured:
| Name | Purpose | Default |
|---|---|---|
None |
||
DEBUG |
If debug mode is enabled. | False |
ENV |
Environment the app is running in. | production |
MAIL_DEFAULT_SENDER |
The default address to send emails from. | None |
MAIL_PASSWORD |
The mail sender's password. | None |
MAIL_PORT |
The mail server port. | 587 |
MAIL_SERVER |
The mail server host name. | smtp.gmail.com |
MAIL_SUPPRESS_SEND |
If mail sending should be suppressed. | False |
MAIL_USE_SSL |
If using mail SSL. | False |
MAIL_USE_TLS |
If using mail TLS. | True |
MAIL_USERNAME |
The mail sender's username. | None |
MONGODB_DB |
The MongoDB database name. | dawdle |
MONGODB_HOST |
The MongoDB host name. | 127.0.0.1 |
MONGODB_PASSWORD |
The MongoDB password. | None |
MONGODB_PORT |
The MongoDB port. | 27017 |
MONGODB_USERNAME |
The MongoDB username. | None |
SECRET_KEY |
A secret key used for security. | default secret key |
SERVER_NAME |
The host and port of the server. | 127.0.0.1:5000 |
SESSION_COOKIE_DOMAIN |
The domain match rule that the session cookie will be valid for. | 127.0.0.1:5000 |
WTF_CSRF_ENABLED |
If CSRF protection is enabled. | True |
To change these properties you can export them as environment variables or create a file instance/config.py (note
that any environment variables take precedence).
URI style connections are also supported for connecting to MongoDB, just supply the URI as MONGODB_HOST (note that
URI properties will take precedence).
The app requires an email address to send messages from e.g. for user verification. You don't need your own mail server for this. You can use a Gmail account with the following settings:
MAIL_DEFAULT_SENDER = <Gmail address>
MAIL_PASSWORD = <Gmail password>
MAIL_PORT = 587
MAIL_SERVER = 'smtp.gmail.com'
MAIL_SUPPRESS_SEND = False
MAIL_USE_SSL = False
MAIL_USE_TLS = True
MAIL_USERNAME = <Gmail address>
Make sure to add these to your instance/config.py file in order to run locally.
The app can be run with Docker or without Docker.
From your terminal/command prompt run:
docker-compose up
Then point your browser to http://127.0.0.1:5000/.
- (Optional) Install virtualenv and virtualenvwrapper and create a new environment.
- Run
pip install -r requirements.txt.
You can either:
- Install MongoDB locally by going here.
or:
- Create a database in the cloud using MongoDB Atlas.
From your terminal/command prompt run:
./run.py
Then point your browser to http://127.0.0.1:5000/.
For those of you that are interested, the technology used in this project includes:
This project is licensed under the MIT License - see the LICENSE file for details.