maximum-maxness / CalgaryHacks2021

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

TaskHome

A place of productivity.
View Demo · Report Bug

Table of Contents

  1. About The Project
  2. Getting Started

About The Project

The goal of this project was to help give not only ourselves, but all other students a way to overcome motivation drought and a overwhelming sense of social isolation in their day-to-day academic ongoings. We aimed to acheive this by providing a way to have friends be a source of external accountability for those around them, more specifically, a social task tracker, with shared goals throughout the week. You must keep your streak going strong, or else your house of accountability will start to fall apart and you'll have to downgrade. On the flipside, if you keep a regular schedule and stick to your weekly goals, then it's nowhere but up for you, with only accountability house upgrades coming your way!

Built With

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • npm
    npm install npm@latest -g
  • Python 3.9 installed along with pip and pipenv

    pip -m python3.9 -m pip install pipenv --upgrade
  • Docker

Installation

  1. Clone the repo and cd into it

    git clone https://github.com/maximum-maxness/CalgaryHacks2021.git
    cd ./calgaryhacks2021/
  2. Set up the pipenv virtual environment

    pipenv install
    pipenv shell
  3. Open in VSCode and run the 'Reinit DB, Migrate and Run DJango' task

  4. After that is done, cd into the frontend subfolder within the project

    cd ./frontend
  5. Install the required npm packages and start npm after the install

    npm install
    npm start
  6. Done! The frontend is now accessible at http://127.0.0.1:3000 while the backend is accessible at http://127.0.0.1:8000

Contact

Project Link: https://github.com/maximum-maxness/CalgaryHacks2021

About


Languages

Language:Python 58.7%Language:JavaScript 22.8%Language:CSS 8.0%Language:HTML 7.7%Language:Dockerfile 2.6%Language:Shell 0.2%