Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/urdadx/spacely

your personalized productivity buddy πŸ›Έ
https://github.com/urdadx/spacely

nature nextjs pomodoro productivity spaced-repetition

Last synced: about 1 month ago
JSON representation

your personalized productivity buddy πŸ›Έ

Awesome Lists containing this project

README

        

# SpacelyπŸ›Έ

Spacely is a place to chill and relax while studying.

The goal of Spacely is to provide users with a platform that helps them to chill and relax while studying.

Official site: [https://spacely.vercel.app](https://spacely.vercel.app)

## βš’οΈ Demo

https://github.com/urdadx/spacely/assets/70736338/654c1a7d-987a-40fc-9ee3-f2282294a13f

## ⭐ Features

It has 4 Core Features:
|

**Feature**
| **Description** |
|---|---|
| **1. Play nature sounds** | You can select from a range of carefully selected sounds to help you relax |
| **2. Keep track of tasks** | You can create and manage a todo list of all your tasks|
| **3. Pomodoro Timer** | Use the pomodoro timer to schedule your study routines |
**4. Privacy centered** | All your data belong to you and are stored locally on your machine.

## πŸ“š Tech Stack

|

**Category**
|
**Choice**
| **Descriptions** |
| ------------------------------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| **Language** | [JavaScript](https://github.com/microsoft/TypeScript) | JavaScript (JS) is a cross-platform, object-oriented programming language used by developers to make web pages interactive. |
| **UI Library** | [React](https://github.com/facebook/react) | React’s declarative syntax and component-based architecture make it simple to develop reactive reusable components. |
| **CSS Framework** | [Tailwind CSS](https://github.com/tailwindlabs/tailwindcss) | Tailwind speeds up development by providing helpful css utilities and removing the need to context switch between jsx and css files. |
| **Web Framework** | [NextJS 13](https://github.com/vercel/next.js) | Next.js supports static site generation and helps build efficient React webpages that support SEO. |

## πŸ“ Project Structure

Spacely is created with the NextJS web framework and follows its project structure.

|

**Page Route**
| **Code Path** | **Description** |
| --------------------------------------------- | ---------------------- | ----------------------------------------------- |
| / | /index.jsx | Home page/ landing page |
| /components | /components | Contains all the components used in the project |
| /playground | /core/playground.jsx/ | The user's playground |
| /playground | /core/focus-panel.jsx/ | Houses the todo app and pomodoro timer |

## πŸ’» Local Development

1. Download the repo `git clone https://github.com/urdadx/spacely.git`
2. Change the directory `cd spacely`
3. Install the dependency `npm install`
4. Start a development server `npm run dev`
5. Open your browser and visit [http://localhost:3000](http://localhost:3000) to see Spacely live

## Contributing 🀝

We love our contributors! Here's how you can contribute:

- [Open an issue](https://github.com/urdadx/spacely/issues) if you believe you've encountered a bug.
- Make a [pull request](https://github.com/urdadx/spacely/pull) to add new features/make quality-of-life improvements/fix bugs.



## Repo Activity

![Alt](https://repobeats.axiom.co/api/embed/9012953bd5a147f58c81adce751b434f292d1bb5.svg 'Repobeats analytics image')

## Liscence πŸ“

MIT

## Give this repo a star ⭐.