diff --git a/README.md b/README.md index a68e119..e1cfc69 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,7 @@ This app is intended to use with tracking personal fitness providers and visits I will build this with LAPP stack - Linux, Apache, PHP & Python. I will build the front-end in PHP, and the back-end will be a Python API with a database. The database will be a SQLite file handled by the Python service. There will need to be a Users table, a Providers table, and a Visits table. The Users table will contain the information and settings for the site users. The settings can be a JSON structure inside a single text entry. The Providers table will track the Providers info and rates. The rates will also be a JSON structure in a single text field. Any user can add a provider, and set it private or not. If not private, other users can add visits for the same provider. The Visits table will contain enties for User Visits to Providers. This will have date, time, location, provider, cost. There should be a initialize_db function that checks for the file and creates it if needed, including all tables. Here is a complete list of data for each table. +''' Users - Name - ID # this can be an int value automatically incremented by the database @@ -25,6 +26,9 @@ The database will be a SQLite file handled by the Python service. There will nee - Cost - Location - Timestamp +''' + +''' Here is a list of functions to start with get_user(name, id, username, fields) This can search user by either name, id, or username depending on what is passed. Will return user data in JSON, fields is optional and will return only fields listed in this variable @@ -44,7 +48,7 @@ Here is a list of functions to start with This will allow for updating a user and will return a status and ID as well. update_visit(id, user, provider, cost, location, time) In case changes need to be made to a recorded visit. - +''' The API will be how the site interacts with the database. There will need to be subroutines for searching the database here, and that will depend on how the front-end works out.