Initial version

Gergely Polonkai 2018-07-10 11:06:13 +00:00
commit 50457e2d7a

48
Home.md Normal file

@ -0,0 +1,48 @@
# Requirements
## Runtime and dependencies
Calendar.social runs under Python 3.6+ (tested with 3.6.5.)
To install dependencies, you will need [pipenv](https://docs.pipenv.org/). Some Linux distributions (like Fedora) have it in their repository. On others, you can install it with
pip install --user pipenv
Refer to its documentation for more information.
## Database
The development environment is set up to use an SQLite3 database local.db` under the `calsocial` directory. You can use any other relational database supported by [SQLAlchemy](http://www.sqlalchemy.org/) if you set the `SQLALCHEMY_DATABASE_URI` value in `calsocial/config_dev.py`.
# How to set up the app
**WARNING** Calendar.social is in a very early phase of development. It may require a lot of legwork to make it work for you.
## Install the dependencies
To do so, run
pipenv instlal
If you also want to do development, you may also run
pipenv install --dev
## Create the database
To create the database, you have to run the Flask shell:
pipenv run env FLASK_APP=calsocial:app flask shell
When you see the `>>>` prompt, use the following two-liner to create the database tables:
```python
from calsocial.models import db
db.create_all()
```
## Run the app
To start the app, you just have to run `calsocial` as a module:
pipenv run env PYTHONPATH=$(pwd) python -m calsocial
After this, your local instance is available on http://127.0.0.1:5000/