Skip to content

Commit 1fda6fb

Browse files
authored
more information in readme.md
1 parent 0009813 commit 1fda6fb

1 file changed

Lines changed: 14 additions & 8 deletions

File tree

README.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
# flask-base [![Circle CI](https://circleci.com/gh/hack4impact/flask-base.svg?style=svg)](https://circleci.com/gh/hack4impact/flask-base) [![Stories in Ready](https://badge.waffle.io/hack4impact/flask-base.png?label=ready&title=Ready)](https://waffle.io/hack4impact/flask-base) [![Code Climate](https://codeclimate.com/github/hack4impact/flask-base/badges/gpa.svg)] (https://codeclimate.com/github/hack4impact/flask-base/coverage) [![Issue Count](https://codeclimate.com/github/hack4impact/flask-base/badges/issue_count.svg)](https://codeclimate.com/github/hack4impact/flask-base) ![python3.x](https://img.shields.io/badge/python-3.x-brightgreen.svg) ![python2.x](https://img.shields.io/badge/python-2.x-yellow.svg)
1+
# flask-base
2+
[![Circle CI](https://circleci.com/gh/hack4impact/flask-base.svg?style=svg)](https://circleci.com/gh/hack4impact/flask-base) [![Stories in Ready](https://badge.waffle.io/hack4impact/flask-base.png?label=ready&title=Ready)](https://waffle.io/hack4impact/flask-base) [![Code Climate](https://codeclimate.com/github/hack4impact/flask-base/badges/gpa.svg)] (https://codeclimate.com/github/hack4impact/flask-base/coverage) [![Issue Count](https://codeclimate.com/github/hack4impact/flask-base/badges/issue_count.svg)](https://codeclimate.com/github/hack4impact/flask-base) ![python3.x](https://img.shields.io/badge/python-3.x-brightgreen.svg) ![python2.x](https://img.shields.io/badge/python-2.x-yellow.svg)
23
<img src="readme_media/logo@2x.png" width="400"/>
34

45
A Flask application template with the boilerplate code already done for you.
@@ -29,10 +30,6 @@ Registering User:
2930

3031
![registering](readme_media/register.gif "register")
3132

32-
Admin Homepage:
33-
34-
![admin](readme_media/admin.gif "admin")
35-
3633
Admin Editing Page:
3734

3835
![edit page](readme_media/editpage.gif "editpage")
@@ -41,9 +38,6 @@ Admin Editing Users:
4138

4239
![edit user](readme_media/edituser.gif "edituser")
4340

44-
Admin Adding a User:
45-
46-
![add user](readme_media/adduser.gif "add user")
4741

4842
## Setting up
4943

@@ -80,11 +74,23 @@ $ xcode-select --install
8074

8175
Create a file called `config.env` that contains environment variables in the following syntax: `ENVIRONMENT_VARIABLE=value`. For example,
8276
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.
77+
8378
```
8479
MAIL_USERNAME=SendgridUsername
8580
MAIL_PASSWORD=SendgridPassword
8681
SECRET_KEY=SuperRandomStringToBeUsedForEncryption
8782
```
83+
84+
Other Key value pairs:
85+
86+
* `ADMIN_EMAIL`: set to the default email for your first admin account (default is `flask-base-admin@example.com`)
87+
* `ADMIN_PASSWORD`: set to the default password for your first admin account (default is `password`)
88+
* `DATABASE_URL`: set to a postgresql database url. By default will point to data-dev.sqlite
89+
* `REDISTOGO_URL`: set to Redis To Go URL or any redis server url (default `http://localhost:6379`)
90+
* `RAYGUN_APIKEY`: api key for raygun (default is `None`)
91+
* `FLASK_CONFIG`: can be `development`, `production`, `default`, `heroku`, `unix`, or `testing`. Most of the time you will use `development` or `production`.
92+
93+
8894
**Note: do not include the `config.env` file in any commits. This should remain private.**
8995

9096
##### Install the dependencies

0 commit comments

Comments
 (0)