Skip to content

Latest commit

 

History

History
188 lines (123 loc) · 4.83 KB

README.md

File metadata and controls

188 lines (123 loc) · 4.83 KB
Raw

Logo

Study House

Don't let distractions steal the show, stay focused and let your study house grow!
Explore the docs »

Instagram

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Creating A Project
  5. Developing
  6. Building
  7. Deploy
  8. Contact

About The Project

Logo

Studies show 80-95% of college students procrastinate, with 50% college students procrastinate in a consistent and chronic manner. StudyHouse is a webapp and extension combo aimed to break the cycle of procrastination and build healthy work habits. Users who use StudyHouse earns coins each time in which they can use to purchase furnitures and decorations to customize their own house. StudyHouse offers this experience for all students who wish to stay on top of their work and never miss another deadline!

Features:

  • Blocks distracting website during study session
  • Earn coins to purchase furnitures
  • Customizable furniture and decoration for each room
  • Specify blocked website list
  • Friend feature

Built With

StudyHouse is built using the following frameworks:

  • Svelte
  • Firebase

Getting Started

Ready to start using StudyHouse? Follow these steps to join our community!

Prerequisites

Make sure you have google chrome installed!

Installation

Installation for the extension

  1. Clone the repo

    git clone https://github.com/kmjson/StudyHouse-Extension.git

  2. In Google Chrome, navigate to Windows -> Extension

  3. Click 'Load unpacked'

  4. Navigate to the cloned repo above and click select

  5. Enable and pin the extension

Logo

Usage

Once you have the extension downloaded, navigate to our website at https://studyhouse-74491.web.app/ and login with google!

Creating A Project

If you're seeing this, you've probably already done this step. Congrats!

# create a new project in the current directory
npm create svelte@latest

# create a new project in my-app
npm create svelte@latest my-app

Developing

Once you've created a project and installed dependencies with npm install (or pnpm install or yarn), start a development server:

npm run dev

# or start the server and open the app in a new browser tab
npm run dev -- --open

Building

To create a production version of your app:

npm run build

You can preview the production build with npm run preview.

To deploy your app, you may need to install an adapter for your target environment.

Deploy

To deploy your application:

firebase deploy

https://studyhouse-74491.web.app/

Contact

StudyHouse - @study.house_

Jason Kim - [email protected]

Jarrett Fok - [email protected]

Sambridhi Subedi - [email protected]

Colette Li - [email protected]

John Bolognino - [email protected]

Project Link: https://github.com/kmjson/StudyHouse/