Skip to content

Commit 0eac4f4

Browse files
committed
Update README.
1 parent 7fdbffa commit 0eac4f4

File tree

4 files changed

+199
-44
lines changed

4 files changed

+199
-44
lines changed

README.md

+15-34
Original file line numberDiff line numberDiff line change
@@ -12,50 +12,31 @@
1212

1313
Build and code-split your frontend assets across Blueprints using Flask-Assets. Accompanying tutorial on Hackers and Slackers here: https://hackersandslackers.com/flask-assets/
1414

15-
## Installation
15+
# Getting Started
1616

17-
**Installation via `requirements.txt`**:
17+
Get set up locally in two steps:
1818

19-
```shell
20-
$ git clone https://github.com/hackersandslackers/fflask-assets-tutorial.git
21-
$ cd flask-assets-tutorial
22-
$ python3 -m venv myenv
23-
$ source myenv/bin/activate
24-
$ pip3 install -r requirements.txt
25-
$ flask run
26-
```
27-
28-
**Installation via [Pipenv](https://pipenv-fork.readthedocs.io/en/latest/)**:
29-
30-
```shell
31-
$ git clone https://github.com/hackersandslackers/flask-assets-tutorial.git
32-
$ cd flask-assets-tutorial
33-
$ pipenv shell
34-
$ pipenv update
35-
$ flask run
36-
```
37-
38-
**Installation via [Poetry](https://python-poetry.org/)**:
39-
40-
```shell
41-
$ git clone https://github.com/hackersandslackers/flask-assets-tutorial.git
42-
$ cd flask-assets-tutorial
43-
$ poetry shell
44-
$ poetry update
45-
$ poetry run
46-
```
47-
48-
## Usage
19+
### Environment Variables
4920

5021
Replace the values in **.env.example** with your values and rename this file to **.env**:
5122

52-
* `FLASK_APP`: Entry point of your application (should be `wsgi.py`).
53-
* `FLASK_ENV`: The environment to run your app in (either `development` or `production`).
23+
* `FLASK_APP`: Entry point of your application; should be `wsgi.py`.
24+
* `FLASK_ENV`: The environment in which run your application; either `development` or `production`.
5425
* `SECRET_KEY`: Randomly generated string of characters used to encrypt your app's data.
5526
* `LESS_BIN`: Path to your local LESS installation via `which lessc`.
5627

5728
*Remember never to commit secrets saved in .env files to Github.*
5829

30+
### Installation
31+
32+
Get up and running with `make deploy`:
33+
34+
```shell
35+
$ git clone https://github.com/hackersandslackers/flask-assets-tutorial.git
36+
$ cd flask-assets-tutorial
37+
$ make deploy
38+
```
39+
5940
-----
6041

6142
**Hackers and Slackers** tutorials are free of charge. If you found this tutorial helpful, a [small donation](https://www.buymeacoffee.com/hackersslackers) would be greatly appreciated to keep us in business. All proceeds go towards coffee, and all coffee goes towards more content.

poetry.lock

+162-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pyproject.toml

+14-9
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,13 @@ readme = "README.md"
99
homepage = "https://hackersandslackers.com/flask-assets/"
1010
repository = "https://github.com/hackersandslackers/flask-assets-tutorial/"
1111
documentation = "https://hackersandslackers.com/flask-assets/"
12-
keywords = ["Flask",
13-
"Flask-Assets",
14-
"Bundles",
15-
"MVC",
16-
"Tutorial"]
12+
keywords = [
13+
"Flask",
14+
"Flask-Assets",
15+
"Bundles",
16+
"Frontend",
17+
"Tutorial"
18+
]
1719

1820
[tool.poetry.dependencies]
1921
python = "^3.8"
@@ -26,13 +28,16 @@ python-dotenv = "*"
2628

2729
[tool.poetry.dev-dependencies]
2830
pytest = "*"
29-
30-
[build-system]
31-
requires = ["poetry>=0.12"]
32-
build-backend = "poetry.masonry.api"
31+
black = "^20.8b1"
32+
isort = "^5.6.4"
3333

3434
[tool.poetry.scripts]
3535
run = "wsgi:app"
3636

3737
[tool.poetry.urls]
3838
issues = "https://github.com/hackersandslackers/flask-assets-tutorial/issues"
39+
40+
[build-system]
41+
requires = ["poetry>=0.12"]
42+
build-backend = "poetry.masonry.api"
43+

0 commit comments

Comments
 (0)