Guide to organize file in this project

Directory

database (database and classes)

 - user

  user_schema.py

 - session

 - contact

 - event

 - organization

 - receipt

 - notification

product (API calls)

   - api_functions

  - user

   get_apis.py

   post_apis.py

   put_apis.py

   delete_apis.py

 ...

   - helper_functions

  user_helper.py

  ...

tests

 - database

 - api

Write clean code:

• Make code readable for people (indentation)
• Use meaningful names for variables, functions and methods (short but descriptive)
• Let one function or method perform only one task
• Use comments for clarification
• Be consistent
• Review your code regularly
• Write a function / class:

   Start with comments:

    What does this function / class do?

    What kinds of parameters is taken as input? (function)

    What variables should we store in class? (class)

    What kinds of output will be? (function)

• Make comments/notes as you progress

Set up requirements packages:

Will add more into this as we go.

• Python3
• Flask
• Flask-SQLAlchemy
• PostgreSQL
• PGAdmin4 (to look at database - not really a requirement)