Skip to content

Latest commit

 

History

History
56 lines (38 loc) · 1.36 KB

README.md

File metadata and controls

56 lines (38 loc) · 1.36 KB

DoThisFirst

Introduction

Most of us have things to do every day. Sometimes, these tasks must be done in a certain order. DoThisFirst is a to-do app that supports dependent tasks i.e., tasks that need other tasks to be first completed.

Further Documentation

Project Documentation Google Docs

The project documentation contains:

  • project timeline
  • meeting recaps
  • feature documentation
  • API documentation

UI Designs on Figma

Installation

  1. Clone the repository

    git clone https://github.com/V-X-L-U/Do-This-First.git

  2. Install dependencies (make sure you are the root of the repository)

    cd frontend
yarn install
cd ../backend
yarn install

Running the App (development)

  1. Request and add the .env to the backend/ route.

  2. Run the server (make sure you are at the root of the repository)

    cd backend
yarn start
cd ..

  3. Run the client (make sure you are at the root of the repository)

    cd frontend
yarn start

  4. The client and server should run on port 3000 and 5000 respectively.

Alternatively, run ./startup.sh from the root of the project.