$ git clone https://github.com/skybber/czsky.git
$ cd REPO_NAME
Windows:
$ python3 -m venv venv
$ venv\Scripts\activate.bat
Unix/MacOS:
$ python3 -m venv venv
$ source venv/bin/activate
Learn more in the documentation.
Note: if you are using a python before 3.3, it doesn't come with venv. Install virtualenv with pip instead.
$ xcode-select --install
Create a file called config.env
that contains environment variables. Very important: do not include the config.env
file in any commits. This should remain private. You will manually maintain this file locally, and keep it in sync on your host.
To make it easy to set up this file with the required values, you can use config.env.example as a configuration template.
Variables declared in file have the following format: ENVIRONMENT_VARIABLE=value
. You may also wrap values in double quotes like ENVIRONMENT_VARIABLE="value with spaces"
.
-
In order for Flask to run, there must be a
SECRET_KEY
variable declared. Generating one is simple with Python 3:$ python3 -c "import secrets; print(secrets.token_hex(16))"
This will give you a 32-character string. Copy this string and add it to your
config.env
:SECRET_KEY=Generated_Random_String
-
The mailing environment variables can be set as the following. We recommend using Sendgrid for a mailing SMTP server, but anything else will work as well.
MAIL_USERNAME=SendgridUsername MAIL_PASSWORD=SendgridPassword
Other useful variables include:
Variable | Default | Discussion |
---|---|---|
ADMIN_EMAIL |
flask-base-admin@example.com |
email for your first admin account |
ADMIN_PASSWORD |
password |
password for your first admin account |
DATABASE_URL |
data-dev.sqlite |
Database URL. Can be Postgres, sqlite, etc. |
REDISTOGO_URL |
http://localhost:6379 |
Redis To Go URL or any redis server url |
RAYGUN_APIKEY |
None |
API key for Raygun, a crash and performance monitoring service |
FLASK_CONFIG |
default |
can be development , production , default , heroku , unix , or testing . Most of the time you will use development or production . |
$ pip install -r requirements.txt
You need Redis, and Sass. Chances are, these commands will work:
Sass:
$ gem install sass
Redis:
Mac (using homebrew):
$ brew install redis
Linux:
$ sudo apt-get install redis-server
$ ./recreate_all.sh
$ source env/bin/activate
$ honcho start -e config.env -f Local
For Windows users having issues with binding to a redis port locally, refer to this issue.