User Story: Write Developer Documentation and README
Assignee: Raghunath Kunigiri

Due Date: 2024-07-01

Title: Write Developer Documentation and README

Description:
As a developer, I would like to have comprehensive developer documentation and a README file for our project. This will ensure that all team members and future contributors have a clear understanding of the project's structure, setup, and development practices, facilitating smooth collaboration and efficient development.

Acceptance Criteria:

A README file that includes:
Project title
Project description
Initial setup instructions
Project structure
Tools and libraries used
Contributor information
Additional information or references to further documentation
Developer documentation that includes:
Instructions for setting up the development environment
Detailed project structure and files explanation
Instructions for running the application
Guidelines for managing dependencies
Contributing guidelines

Tasks:

• Add testing dependencies to requirements.txt or Pipfile.
• Create a dedicated directory structure for test cases (e.g., tests/).
• Write Initial Test Cases
• Implement initial unit tests for critical components such as user registration, login, and database models.
• Write integration tests for key workflows like user authentication.
• Write documentation on how to run tests locally and interpret the results.

Documentation:

• Clear documentation is provided on how to run tests locally, along with guidelines for writing and maintaining test cases.

As a developer I would like to have a basic python application up and running with some initial development features so that myself and the rest of the team have a base to begin working on more complex features, can keep track of dependencies and libraries we are using, and share code easily.

DUE DATE:
06/19/24

ACCEPTANCE CRITERIA:
A working python application that servers a web page over a local development server which says "Hello World". Additionally, the project should have the following tools set up for managing the repository:

• A github repository with all project members added as collaborators
• a .gitignore file for third party libraries and other local files
• a requirements.txt file for dependency tracking
• a basic project directory structure for a flask app.

As a user, I want to input and submit my budget information, so that I can track my finances effectively.

Frontend View:

• See a form with fields for income, expenses, and savings goals
• Input financial data into clearly labeled fields
• Submit the form to save my budget
• View a summary of my budget after submission
• Receive visual feedback for any input errors

Backend Logic:

• Create an API endpoint to receive budget form data
• Validate all incoming data for completeness and correctness
• Store the validated budget data in a database
• Calculate totals and percentages for income, expenses, and savings
• Return a success response with a budget summary or error messages

Acceptance Criteria:

1. Form displays all required fields, marked with an asterisk (*)
2. Numeric fields only accept valid numbers
3. Savings goal is expressed as a percentage
4. Form prevents submission if required fields are empty
5. Error messages appear next to relevant fields
6. Loading indicator displays during form submission
7. API responds with appropriate status codes (400 for errors, 201 for success)
8. Database record includes timestamp of budget creation
9. Calculations are accurate to two decimal places
10. User receives a budget summary within 3 seconds of successful submission
11. System handles concurrent requests without data corruption

As a user, I would like a navigation menu that feels intuitive and works similarly to menus I've use before so I can easily navigate the budget planning site.

Due: Tue Jul 9

Acceptance Criteria:

• The navbar component should load on every page except for login/register
• The navbar should show a dropdown menu with a "hamburger" icon for mobile screens
• The dropdown menu should close when the user clicks elsewhere on the page
• The navbar should expand and show a menu bar for larger screen sizes
• The Navbar should contain links to 3 pages: Budget Summary, Budget Form, and Profile

Due Date: July 16, 2024

Description :
As a user, I want to securely log into the application using my credentials so that I can access personalized features and data. The login process should be secure, quick, and reliable, leveraging OAuth 2.0 for authentication and PyJWT for token management. The user credentials should be protected using AES encryption.

Requirement :
Will require database setup

Acceptance Criteria :

Backend Authentication:
Implement OAuth 2.0 for handling user authentication.
Use PyJWT to generate and manage JSON Web Tokens for authenticated sessions.

Database Setup:
Set up a MongoDB database using MongoEngine.
Ensure the database schema includes encrypted storage for user credentials.

Data Security:
Encrypt user credentials using AES encryption before storing them in the database.
Ensure that encrypted credentials are properly decrypted during the authentication process.

Error Handling:
Provide user-friendly error messages for incorrect login attempts.
Implement measures to prevent brute-force attacks.

Testing:
Perform unit tests and security tests to validate the login functionality across all specified platforms.

As a user, I would like to see a categorical summary of the budget I have specified and be able to forecast basic savings and debt calculations for upcoming months.

Due Date: Sun Jul 28th

Key features

• A visualization of the user's expenses broken down by category
• A Summary of Net Income, Fixed and Variable Expenses, and Net balances
• A Visualization of savings accumulation based on monthly contributions for a given number of months
• A Visualization of debt accumulation/payoff based on monthly contributions for a given number of months
• A Button to go back and edit the budget

Acceptance Criteria

• A Budget Summary View that users can navigate to after login
• All of the key features are implemented in the Budget Summary view
• Back-end logic is implemented to provide data to the view (can be a stub if no DB available yet)
• User can navigate back to the budget page