diff --git a/README.md b/README.md index df6f778..df9dce6 100644 --- a/README.md +++ b/README.md @@ -35,26 +35,72 @@ Peak Performer is a simple yet robust to-do list application designed to keep yo ```bash git clone https://github.com/your-repo/peak-performer.git cd peak-performer + ``` -2. Use the provided `run.sh` script to deploy application: - - Run `initial-setup` to: - - Create/load the virtual environment - - Insall depenencies - - Build PostgreSQL database - - - -Load environment variables: -bash -Copy code -./run.sh load-env -Set up a virtual environment and install dependencies: -bash -Copy code -./run.sh install-deps -Initialize the database: -bash -Copy code -./run.sh create-db +2. Use the provided `run.sh` script for setup: + - Create/load the virtual environment, install dependencies, and build PostgreSQL database: + ```bash + ./run.sh initial-setup + ``` + +3. Start the application: + ```bash + ./run.sh run-app + ``` + +## Usage + +Access the application in your browser at `http://127.0.0.1:5001` + +### How to Use the App + +#### 1. Login Page +- Navigate to the login page to access your account. Enter your username and password, then click **LOGIN**. New users can register by clicking "Sign Up". + +
+ +
+ +#### 2. Registration Page +- Create a new account by providing a username and a secure password. Ensure both password fields match before submitting. + ++ +
+ +#### 3. Task Dashboard +- View all your tasks in a neatly organized table. The dashboard displays the task ID, title, description, and status. The task ID is cumulative for all tasks, across users, that are tracked in Peak Performer. + ++ +
+ +#### 4. Add a Task +- Click "Add Task" in the navigation menu. Fill in the task title, description, and status, then click `Create Task`. + ++ +
+ + +#### 5. Edit a Task +- Select the "Edit Task" option. Enter the Task ID and update the desired fields. Leave fields blank to retain current values. + ++ +
+ + +#### 6. Delete a Task +- Choose the "Delete Task" option. Enter the Task ID to delete. Task details are fetched dynamically to ensure accuracy. + ++ +
+ + +#### 7. Log Out +- Use the "Log Out" option in the navigation menu to safely end your session. ## Architecture @@ -78,5 +124,21 @@ Copy code - **Advantages:** - Centralized data access logic. - Simplified testing by isolating database operations. -Centralized data access logic. -Simplified testing by isolating database operations. \ No newline at end of file + +## Configuration +- Set environment variables in a `.env` file, including: + ``` + DB_USER=