Skip to content

Latest commit

 

History

History
120 lines (73 loc) · 5.95 KB

README.md

File metadata and controls

120 lines (73 loc) · 5.95 KB

Image of React Pomodoro Timer

🍅 React Pomodoro Timer

This is a very small project created with the purpose of learning the fundamentals of React.js starting from a simple Create React App.

🎯 About

I've started this project with the idea of reworking one of the ending projects of the Front End Libraries Certification (300 hours) of FreeCodeCamp. I have structured the project with three React components and I have used some native and custom React hooks in order to handle various project features and behaviours.
I have also used the Context API in order to be able to dispatch actions and to avoid prop-drilling (or threading). I have then styled everything with a little bit of custom SASS and I have added a theme switcher in order to be able to toggle the dark mode view.
You can set sessions and breaks for a maximum of 60 minutes: for each mode change you will hear an audio notification.
You can even follow the counter mode & timer in your browser tab name without have the focus on that tab.

▶️ Demo

Here you can find the demo link:

✨ Features

✔️  Use of React hooks and custom hooks
✔️  Use of React Context API
✔️  Counter state & timer in browser tab name
✔️  Audio notification when timer ends
✔️  Theme switcher (light/dark mode)
✔️  Gets theme preference from local storage
✔️  Responsive site

🚀 Technologies

Netlify deploy & configuration

The site is developed with some specific https://netlify.com apis.

Netlify Status

Deploy configuration steps

  1. Connect your GitHub account to Netlify
  2. Select the project
  3. In Settings → Build & Deploy → Set Build command to : npm run build
  4. In Settings → Build & Deploy → Set Publish directory to : build

✅ Requirements

Before starting 🏁, you need to have Git and Node installed.

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

npm run eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Code Splitting

This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting

Analyzing the Bundle Size

This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size

Making a Progressive Web App

This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app

Advanced Configuration

This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration

Deployment

This section has moved here: https://facebook.github.io/create-react-app/docs/deployment

npm run build fails to minify

This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify