Skip to content

urdadx/spacely

Repository files navigation

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

⚒️ Demo

spacely-converted.mp4

⭐ 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 JavaScript (JS) is a cross-platform, object-oriented programming language used by developers to make web pages interactive.
UI Library React React’s declarative syntax and component-based architecture make it simple to develop reactive reusable components.
CSS Framework Tailwind CSS 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 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 to see Spacely live

Contributing 🤝

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

  • Open an issue if you believe you've encountered a bug.
  • Make a pull request to add new features/make quality-of-life improvements/fix bugs.

Repo Activity

Alt

Liscence 📝

MIT

Give this repo a star ⭐.