From ef9aad7dfe881bde9b5816f9cb22103ba83d9987 Mon Sep 17 00:00:00 2001 From: Tea Larson-Hetrick Date: Sat, 9 Aug 2025 04:56:50 -0700 Subject: [PATCH] docs: describe StudyPlanner features --- README.md | 54 ++++++++------ index.html | 203 ++++++++++++++++++----------------------------------- 2 files changed, 102 insertions(+), 155 deletions(-) diff --git a/README.md b/README.md index a880c1e..5ad444e 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,32 @@ -# StudyPlanner - -A brief description of your project, its purpose, and functionality. This study planner is designed to help users stay organized with their studies, tasks, and learning objectives. - -Features include: - -- List of features -- Key functionalities of the application -- Automated task schedules based on user behaviors -- Advanced reporting and analytics to track study progress -- Integration with personal advice through IA - -Installation Guidelines: - -- Step-by-step guides on how to install, setup and use the project locally. -- Prerequisites like Node.js, MongoDB and other dependencies - -```bash -git clone https://github.com/yourusername/StudyPlanner.git -cd StudyPlanner -nmp install -``` +# StudyPlanner + +StudyPlanner is a simple web application that helps you organize your study +tasks and view them in a daily schedule. The client fetches tasks from a REST +API and renders them on the page so you can keep track of what needs to be +done. + +## Features + +- Add new study tasks using the form on the home page +- Display tasks fetched from `/api/tasks` in a dynamic list +- View a basic schedule section for planning your day +- Track progress as you complete items + +## Installation + +Prerequisites: [Node.js](https://nodejs.org/) and [npm](https://www.npmjs.com/). + +```bash +git clone https://github.com/yourusername/StudyPlanner.git +cd StudyPlanner +npm install +``` + +## Usage + +```bash +npm start +``` + +Then open [http://localhost:3000](http://localhost:3000) in your browser to use +the planner. diff --git a/index.html b/index.html index 754787a..80cd110 100644 --- a/index.html +++ b/index.html @@ -1,133 +1,70 @@ - - - - - - - Study Planner - - // Add viewport meta element - Document - - -
-

Study Planner

-
-
-
-

Your Schedule

- -
-
-

Your Tasks

- -
-
- -
-
-
- -
-
-
- - - - - -<<<<<<< Updated upstream - - - - - Document - - - - - - - - - Document - - - - - - - - - - - - - - - // Add viewport meta element - Document - - - - - - - - - - Document - - - - - - - - - Document - - - - - -======= - - - - ->>>>>>> Stashed changes + + + + + + Study Planner + + + +
+

Study Planner

+
+
+
+

Your Schedule

+ +
+
+

Your Tasks

+ +
+
+ +
+
+
+ +
    +
    +
    +
    + + + + + +