PROJECT OVERVIEW:
The purpose of this project is to create a functional autoshop website through which potential customers can insert their information and requested repairs, and through which the website administrator can accept and reject these repairs, mark them finished, (and or recover the repairs if they're rejected) send emails informing customers of the state of their repair requests, and print the necessary forms surrounding the repairs.

IMPORTANT:
Different branches still need to be implemented.They exist in different branches so that it doesnt mess up the master branch code, which we upload onto pythonanywhere.com

IMPORTS: BareNecessities and Mail

FILES AND THEIR PURPOSE:
app.py
	Mailing
		Establishes connection with google's mailing server to allow for automated emailing from the website to customers about requests. 
	Forms
		Using functions in validation.py, validate information given by the user by the rendered html form login.html
		It should be able to save the data passed to accepted/rejected/finished.html and send it in an email.
	Admin Console
		Where the administrator is going to be able to view the data.


EmailTemplates.txt
instance (folder)
	CarDB.sqlite
		This is the location in which the data is actually stored, and you will never really interact with this file directly beyond its creation -- you’ll be using query_db() instead
	config.py
		We’re not entirely sure what this file does, but it seemed important so we left it there to avoid errors.
app (folder)
	database.py
		This is the file in which the python methods exist that you can use to interact with the database. The imports are sqlite3, click, os, from flask import current_app, g, from flask.cli import with_appcontext. The methods are get_db(), query_db(query, args=(), one=False), close_db(exception=None), init_db(), init_app(myApp), inidb_command()
	index.py
		This is the file that was used to test the code, specifically the database code. You can write testing methods with special Flask code, but it’s kind of a pain in the butt, so it’s just easier to create a route and call that to test  your stuff. Also, it adds the email implementation. When a button is pressed by the Admin, index.py routes you to the specific html form that needs to be filled out. Once filled out, it gets the code from the html form and puts it into an email and returns response.html
        Routing
            How to naviate between pages on the website.
	__init__.py
		This has your create_app(test_config=None) function, which is really important in regards to getting the app context in the rest of your files. Be sure to include it. It’s also where you import/register blueprints.
	schema.sql
		The code that is essentially the framework for your database into which you will later insert actual data. You create CarDB.db from the schema, which has all of your tables and columns contained within. 
	toolkit.py
		Gets, sets, adds, removes, and creates data in the database using query_db() but simplified for ease of use by those who don’t understand how query_db() works
	validation.py
		All your stuff from flask 
Static (folder)
	hell.js
	stylesheet.css
		Styling file to create prettier imagery.
templates (folder)
	console.html
		The html file that generates the buttons for the admin window to view the data
	success.html
		a success message, will be rendered in app when form is entered correctly
	login.html
		the html form where user will enter in information, rendered in app.py
	testEmail.html
		Test email to demonstrate the functionality of the emailing functions.
	accepted.html
		Email template that the administrator fills out for when the job is accepted
	rejected.html
		email template that the administrator fills out for when the job is rejected
	finished.html
		email template that the administrator fills out for when the job is finished
	txt.py
		makes file that Mr. Feid uses to print. No need for a pdf when its easier to add the parts of the form to a .txt file
		




PLATFORM REQUIREMENTS:
	None known


SEQUENTIAL INSTALLATION INSTRUCTIONS:
**Download PyCharm and install everything on that. It has its own console and terminal. Also it can display html**
	General Dependencies (Install First)
		python 3 (or greater), Flask, flaskMail, pdfkit (if implementing PDF functionality)
	Dependencies for Database:
		None

INSTALL FROM GITHUB:
	Ask Mr. Hayes for the github repo url -- he should have been made owner. If not, it’s called MSHP. Good luck finding that (it stands for Magical Sparkly Handheld Polyhedrons, but that was too long.)
	
History: Made by MSHP team in 2019, picked up by CDKT team in 2020. 

USING PROJECT:
	How to configure the project:
		Log into pythonanywhere.com
			user: nchsautoshop
			password: Redhawks2020
		Sometime in February, we bought a full year subscription. it should be able to run next year. Once the subscription ends, it's going to have to be renewed
		
	How to run the project:
		If you have the website running, type in nchsautoshop.pythonanywhere.com (so far)
	
Notes:		
		
	
		
		
CHANGES FOR THE FUTURE:
- Button functionality (there is some backend for these things):
	- Pressing Accept/Reject should prompt Mr. Feid to send an email (which he should be allowed to send as default or modify)
	- Pressing Accept/Reject should update the Accept/Reject boolean in the database.
	- Pressing Reject and sending the email should remove the particular request from the admin console and move it to the archive
	- Pressing Accept and sending the email should switch the button to completed and offer Mr. Feid a way to print the manual form he needs to print.
- Additional Things (There is currently no backend created for these things):
	- Security Implementations: 
		- Login to the admin console should exist.
		- Security features should be investigated and implemented.

Note for the email functionality: it's almost functional but a little buggy. what you have to do to reroute it after the button is pressed in sinstra and destra

example:
def sinistra(repairID):
    if (getRepairAccepted(repairID) == 0 and getRepairRejected(repairID) == 0 and getRepairCompleted(repairID) == 0): # pending
        setRepairAccepted(repairID, 1)
        setRepairCompleted(repairID, 0)
        setRepairRejected(repairID, 0)
        response() # this is what will reroute to the email page, which still doesn't work but should not be too hard to debug
     ...