Skip to content
This repository was archived by the owner on Jul 30, 2022. It is now read-only.

README.md

Latest commit

 

History

History
93 lines (63 loc) · 1.69 KB

README.md

File metadata and controls

93 lines (63 loc) · 1.69 KB

UTimeManager

Plan, Record and Review your weekly schedule

Documentation

Introduction • Installation • Running the App

Introduction

Plan, Record and Review your weekly schedule

  • Easy to Use

    In just a few clicks, you can plan out your schedule for the week to follow!

  • Focus on What Matters

    From your planned out time schedule, you can spend more time focusing on your studies!

Installation

Github

  1. Download the repository
git clone https://github.com/GDSCUTM-CommunityProjects/UTimeManager

Installation

  1. Install the following requirements
  • Yarn >= 2+
  • Node >= 14.17.0
  1. Install the dependencies for the client
cd client
yarn install
  1. Install the dependencies for the server
cd backend
yarn install

Running the app

Client Setup

  1. Running the client
yarn run start

Server Setup

  1. Setting up the server .env file
JWT_SECRET="YOUR JWT SECRET"
MONGO_URI="YOUR MONGO URI"
NODE_ENV="YOUR NODE ENVIRONMENT"
PORT="SERVER PORT"
  1. Running the server
yarn run start

Note: The server will fail to start if the server can't connec to your Mongo database.

The client and server will be listening and serving on port 3000 and 5000 respectively.