issues
search
fack2
/
attention-training
Attention training is a project that helps neuro-diverse people diagnose their specific type of ADHD and provides guidance to them.
MIT License
0
stars
2
forks
source link
Project Documentation
#21
Open
FarahZaqout
opened
5 years ago
FarahZaqout
commented
5 years ago
Write and continuously update the project's readme as needed to include the following:
[x] Project Title
[x] Quick description of the project
[x] Motivation behind the project (from the initial github discussion with philip)
[x] Heroku Link
Current State of the App:
[x] Describe to the PO and the London leads the current state of the app
Which views are up on the live site
Which views are up but not linked with other views
If so, what to type in the url to view them until we link them to the rest of the views.
[x] This needs to be removed by the end of the MVP development process.
Development
[x] How to install and run the project on local machines
[x] Any configurations/env variables.
[x] App architecture.
What is the overall architecture (server, client...etc) and how they interact with the user and among themselves.
[x] Any 3rd party APIs used, what they do and how they interact with the app/user
[x] Describe the app flow in bullet points (include directories if needed).
Production
[x] List any requirements for production setup if needed.
Debugging and Troubleshooting
[x] Are there any logs to check? (e.g. heroku tail logs)
How to check these logs
[x] Any place/service we use to record crashes?
Future Plans/Priorities
[ ] List any bugs that should be dealt with.
[ ] List any unfinished user stories (in order of importance)
[ ] List any stretch goals remaining.
[ ] List any recommended changes when scaling the app (e.g. change 3rd party APIs, change deployment service, modify the architecture...etc).
Write and continuously update the project's readme as needed to include the following:
Current State of the App:
Development
Production
Debugging and Troubleshooting
Future Plans/Priorities