Skip to content

Commit

Permalink
Shell startup and docs update
Browse files Browse the repository at this point in the history
- added startup.sh script for installing and running server (to add git cloning stage)
- updated docs
  • Loading branch information
vexy committed Mar 2, 2020
1 parent 135fed7 commit a84fd15
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 6 deletions.
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
# Simple JWT authentication template
This repository represents the source code template for `JWT` based authentication.
It can be used as starting point for more complex projects and needs.
# Authentication mechanism based on Flask + JWT
This repository represents the source code template for `Flask` implementation of `JWT` based authentication.
It can be used as starting point for more complex projects and requirements or can be completely customised to serve your needs.

## Installation and usage
Perhaps the easiest way to start using this template would be as follows:
- `clone` this repository
Perhaps the easiest way to start would be executing `startup.sh` script. Simple `(user)$ . startup.sh` would do the trick on UNIX based systems.

Alternatively, step by step guide would be:
- `clone` this repository (*aim for master*)
- `cd flask-auth-template`
- `pip install requirements.txt`
- `pip3 install -r requirements.txt`
- `python3 auth-module.py`

**NOTE:** if you're on `MacOS` platforms, there might be a struggle with running this project due to known collision of `Python2.7` and `Python3+`. The conflict might be seen as "Module Import Error" no matter which Python you are using.
To solve this, you might have to "fix" your `PYTHONPATH`. Check out this [article](https://bic-berkeley.github.io/psych-214-fall-2016/using_pythonpath.html) for more information.
Expand Down
12 changes: 12 additions & 0 deletions startup.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Startup script. Will install needed modules and run the server
# origin clone and hard reset
echo "Cloning latest master"
# add git shell later

# pip packages
echo "Installing needed modules via pip..."
pip3 install -r requirements.txt

# server start
echo "Starting server in DEBUG mode"
python3 auth-module.py

0 comments on commit a84fd15

Please sign in to comment.