Github: https://github.com/hack4impact/flask-base
フラスコベース
ボイラープレートコードが既にあなたのために作成されているFlaskアプリケーションテンプレート。
http://hack4impact.github.io/flask-baseにあるドキュメント。
何が含まれていますか？
- 青写真
- ユーザーとアクセス許可の管理
- Flask-SQLAlchemy for databases
- フォーム用Flask-WTF
- アセットマネジメントとSCSSコンパイルのためのFlask-Assets
- 電子メールを送信するFlask-Mail
- gzip圧縮
- 非同期タスクを処理するためのRedis Queue
- ZXCVBNパスワード強度チェッカー
- ページを編集するためのCKEditor
デモ
ホームページ：
ユーザーの登録：
管理編集ページ：
管理者の編集ユーザー：
セットアップ
レポをクローン
$ git clone https://github.com/hack4impact/flask-base.git
$ cd flask-base
virtualenvを初期化する
$ pip install virtualenv
$ virtualenv -p /path/to/python3.x/installation env
$ source env/bin/activate
Macユーザーの場合は、
$ pip install virtualenv
$ virtualenv -p python3 env
$ source env/bin/activate
注意：python2.xバージョンを使用している場合は、-p値をpython2.xパスの方に向けます
（Macの場合）xcodeツールがインストールされていることを確認してください
$ xcode-select --install
環境変数を追加する
次の構文で環境変数を含むconfig.envというファイルを作成しますconfig.env ENVIRONMENT_VARIABLE=value 。 ENVIRONMENT_VARIABLE="value with spaces"ように二重引用符で値をラップすることもできENVIRONMENT_VARIABLE="value with spaces" 。 例えば、郵送環境変数は以下のように設定することができます。 郵送SMTPサーバにはSendgridを使用することをお勧めしますが、他のものも同様に動作します。
MAIL_USERNAME=SendgridUsername
MAIL_PASSWORD=SendgridPassword
SECRET_KEY=SuperRandomStringToBeUsedForEncryption
その他のキー値のペア：
-
ADMIN_EMAIL：最初の管理者アカウントのデフォルトのメールアドレスに設定します（デフォルトはflask-base-admin@example.com） -
ADMIN_PASSWORD：最初の管理者アカウントのデフォルトパスワードに設定します（デフォルトはpassword） -
DATABASE_URL：postgresqlデータベースurlに設定されます（デフォルトはdata-dev.sqlite） -
REDISTOGO_URL：Redis To Go URLまたは任意のredis server URL（デフォルトはhttp://localhost:6379）に設定します。 -
RAYGUN_APIKEY：RAYGUN_APIKEYapiキー（デフォルトはNone） -
FLASK_CONFIG：development、production、default、heroku、unix、testingいずれかです。 ほとんどの場合、developmentまたはproductionを使用します。
注：コミットにconfig.envファイルを含めないでください。 これは非公開でなければなりません。
依存関係をインストールする
$ pip install -r requirements.txt
ローカルで実行するためのその他の依存関係
RedisとSassが必要です。 可能性があります、これらのコマンドは動作します：
サス：
$ gem install sass
レディス：
Mac（ 自作を使用）：
$ brew install redis
Linux：
$ sudo apt-get install redis-server
PostgresQLもインストールする必要があります
Mac（自作を使用）：
brew install postgresql
Linux（この問題に基づいて）：
sudo apt-get install libpq-dev
データベースを作成する
$ python manage.py recreate_db
その他の設定（データベース内での役割の作成など）
$ python manage.py setup_dev
これにより、 ADMIN_EMAILおよびADMIN_PASSWORD設定変数で指定された電子メールとパスワードを持つ管理者ユーザーが作成されます。 指定されていない場合は、それぞれflask-base-admin@example.comとpasswordです。
[オプション]偽のデータをデータベースに追加する
$ python manage.py add_fake_data
アプリの実行
$ source env/bin/activate
$ honcho start -f Local
ローカルのredisポートへのバインドに問題があるWindowsユーザーの場合は、 この問題を参照してください。
コードの書式設定
フラスコベースの変更を提出する前に、あなたのコードをpython manage.py formatしたいかもしれません。
貢献する
貢献は歓迎です！ このプロジェクトのGitHubの問題と自動的に同期するワッフルボードをチェックしてください。 詳細については、行動規範を参照してください。
ドキュメントの変更点
ドキュメントを変更するには、 Mkdocsのドキュメントを参照してください。
新しいドキュメントページを作成するには、 docs/ディレクトリにファイルを追加し、 mkdocs.ymlを編集してファイルを参照します。
新しいファイルがmasterマージされ、githubにプッシュされたとき。 オンラインドキュメントを更新するには、 mkdocs gh-deployを実行します。