Commit b83c2302 authored by Landon DeCoito's avatar Landon DeCoito

Formatting changes for README

parent a203ac39
...@@ -14,11 +14,11 @@ Step 3 - Create a web page that list out all the events and change what are pres ...@@ -14,11 +14,11 @@ Step 3 - Create a web page that list out all the events and change what are pres
# Setup instructions for local development # Setup instructions for local development
1) Have python 2 installed 1) Have python 2 installed
2) Create a `virtualenv` if you know what that is 2) Create a `virtualenv` if you know what that is
3) Install the project's dependencies by running `pip install -r requirements.txt` 3) Install the project's dependencies by running `pip install -r requirements.txt`
4) Install redis-server with `sudo apt install redis-server` 4) Install redis-server with `sudo apt install redis-server`
5) Start the Flask development server by running `./start.sh` 5) Start the Flask development server by running `./start.sh`
NOTE: redis-server is easy to exploit, as described in the redis quick start documentation below. Make sure you firewall the port your redis server is running on (if you open your server to outside IPs) to protect the database NOTE: redis-server is easy to exploit, as described in the redis quick start documentation below. Make sure you firewall the port your redis server is running on (if you open your server to outside IPs) to protect the database
NOTE 2: I'm not 100% sure, but I believe you may need to run the redis-server by typing `redis-server` into the terminal. Don't forget that you can use `redis-cli [command] [key]` to check to see if your database changes have been recorded (or to modify your db manually) NOTE 2: I'm not 100% sure, but I believe you may need to run the redis-server by typing `redis-server` into the terminal. Don't forget that you can use `redis-cli [command] [key]` to check to see if your database changes have been recorded (or to modify your db manually)
...@@ -41,8 +41,8 @@ The masontoday functions are currently separated in a few modules: ...@@ -41,8 +41,8 @@ The masontoday functions are currently separated in a few modules:
#### App Structure #### App Structure
The app has three main components: The app has three main components:
1) The Flask server [set up in \_\_init\_\_] 1) The Flask server [set up in \_\_init\_\_]
* Including the URL Routing (with the use of `@app.route("/")`) * Including the URL Routing (with the use of `@app.route("/")`)
2) The Redis DB [set up in redisactions] 2) The Redis DB [set up in redisactions]
* Routed through localhost port 6379 (this can be changed) * Routed through localhost port 6379 (this can be changed)
3) The scheduler [set up in appmethods] 3) The scheduler [set up in appmethods]
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment