Skip to content

Commit 85d7586

Browse files
authored
Update README.md
1 parent 7761f0f commit 85d7586

1 file changed

Lines changed: 13 additions & 33 deletions

File tree

README.md

Lines changed: 13 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -15,40 +15,11 @@ Add user authentication to your Flask app. Tutorial found here: https://hackersa
1515

1616
![Flask Login](https://raw.githubusercontent.com/toddbirchard/flasklogin-tutorial/master/flask_login_tutorial/static/dist/img/flasklogin%402x.jpg)
1717

18-
## Installation
18+
## Getting Started
1919

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

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

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

@@ -61,9 +32,18 @@ Replace the values in **.env.example** with your values and rename this file to
6132
* `LESS_RUN_IN_DEBUG`: Debug LESS while in `development` (optional).
6233
* `COMPRESSOR_DEBUG`: Debug asset compression while in `development` (optional).
6334

64-
6535
*Remember never to commit secrets saved in .env files to Github.*
6636

37+
### II. Installation
38+
39+
Get up and running with `make deploy`:
40+
41+
```shell
42+
$ git clone https://github.com/toddbirchard/flasklogin-tutorial.git
43+
$ cd flasklogin-tutorial
44+
$ make deploy
45+
```
46+
6747
-----
6848

6949
**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.

0 commit comments

Comments
 (0)