Skip to content

a behavior tracking and rewards application for encouraging positive behavioral changes, particularly in younger chilrdren

License

Notifications You must be signed in to change notification settings

oscisn93/starred

Repository files navigation

Starred

Starred is a behavior-tracking and rewards application that's designed to encourage positive behavioral changes, particularly in younger children. This project is built using React.

Table of Contents

  1. Getting Started
  2. Installation and Configuration
  3. Navigation
    1. Landing Page
    2. Login Page/Register Page
    3. Home Page
      1. Search Bar
      2. Profile/User
      3. Tasks
    4. Dashboard Tab

Getting Started

Before you begin, make sure you have Node.js and npm installed on your machine.

Installation and Configuration

  1. Clone the repository:

    git clone https://github.com/oscisn93/starred.git
  2. Navigate to the project directory:

    cd starred
  3. Install project dependencies:

    npm install
  4. Build the project:

    npm run dev

Navigation

Here's how you can navigate through the Starred app:

1. Landing Page

When you launch the app, the landing page will greet you with two prominent options: 'Log In' or 'Register.' To access your existing account, click the 'Login' button. If you're new to our platform, click 'Register' to create an account. image

2. Login Page/Register Page

If you've selected the 'Login' button, you'll be directed to our login page. Please enter your account email and password, and then click the 'Login' button. image

If you've selected the 'Register' button, you'll be redirected to our registration page. Please provide your account email, password, and password confirmation, and then click the 'Register' button.

3. Home Page

After selecting either the login or register button, you will be redirected to our home page. image

3.1 Search Bar

At the top of the home page, you'll find a search bar that searches for existing tasks throughout the application. Screenshot 2023-10-28 150618

3.2 Profile/User

At the top right of the home page, you'll find your profile. Screenshot 2023-10-28 150618

On the right side of the screen, just under the banner, you'll be able to see the guardians or parents who are contributing to your profile. Screenshot 2023-10-28 150618

3.3 Tasks

In the middle of the screen, you'll find the task section, which features three distinct categories for your tasks. Screenshot 2023-10-28 150618

Beneath that, on the bottom right, you can access your in-progress tasks. Screenshot 2023-10-28 150618

At the bottom right, you'll be able to view your upcoming tasks. Screenshot 2023-10-28 150618

4. Dashboard Tab

On the left side of the screen, you'll find our dashboard, where you can navigate to the Home, Calendar, Task, and Information tabs. The Home tab will take you back to our home page, while the Calendar tab will direct you to our calendar, where you can view task dates. If you wish to log out, simply click the 'Log Out' button located at the bottom. Screenshot 2023-10-28 150618

About

a behavior tracking and rewards application for encouraging positive behavioral changes, particularly in younger chilrdren

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •