Skip to content

sharpirate/need-to-break

Repository files navigation

home

Using The App

Working With Timelines

A Timeline is a sequence of work and break intervals that can help you track your screen time with the help of timers.

Go to the Timeline screen by clicking the Timeline tab in the top navigation:

timelinescreen

Use the Timeline Duration and Interval Size controls to create your timeline:

timdur

The generated Timeline will appear at the bottom of the page and it will be updated automatically every time you make a change.

Once you are done making changes, click on the Start button to start the Timeline:

starttim

Once you start the Timeline, you will see the active Timeline screen. Here you can keep track of your work and break intervals.

Cick on the Stop Timeline button if you want to delete the current active Timeline and start over:

stop

Using Presets

You can save a Timeline to your account for later use. This is called a Preset.

Create a new Timeline from the Timeline screen and click the Save button:

savetim

You will see a modal prompting you to create an account.

Enter your username and password and click the Sign Up button:

signupclick

Once you create your account, click on the Save button once again. You should see a new modal appear prompting you to save your timeline.

Enter the name of your Preset and click the Save button:

savepre

Once you have saved your Preset, you will be redirected to the Presets screen where you can manage all of your Presets.

To delete a Preset, click on the Delete button:

delpre

You will see a modal prompting you to delete the preset.

Click on the Delete button:

delmodal

Local Setup

1. Install Packages

Clone the repo and run npm install from the repository's root to install the required package dependencies

2. Running Locally

Run npm run dev from the repository's root to start the local dev build.

Go to localhost:3000 to access the app:

local

(Optional) Configure Firebase

If you want to be able to save presets you need to connect the app to Firebase.

Go to https://firebase.google.com/ and create a new Web app.

Go to https://console.firebase.google.com/ and find your app's firebaseConfig.

Create a file called .env.development.local in the project's root and set your environment variables to match the firebaseConfig
(You can reference the provided example .env.development file):

envlocal

Restart the dev server by running npm run dev again.

You should be able to create an account and save presets.

About

Web app for managing your screen time

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published