Skip to content

Latest commit

 

History

History
129 lines (103 loc) · 3.1 KB

README.md

File metadata and controls

129 lines (103 loc) · 3.1 KB
Raw

2021-fall-cs160-chocolate-cake

CheckingN


CheckingN

Book tutoring appointments with CheckingN.

Table of Contents

Key Features

  1. Google Sign-in
  2. Book an appointment with available tutor
  3. Book online appointments through Zoom

Dependencies

  • Golang
  • React-datepicker
  • Font Awesome

Getting Started

Installation

In IDE:

  1. Install MongoDB and Golang
  2. Clone the Github repository with the following link: https://github.com/Lee-Taeho/2021-fall-cs160-chocolate-cake.git
  3. Go to the client directory in the terminal with:
cd client
  1. Install packages and dependencies with the following:
npm install
  1. Installing font awsome In the client directory,
npm i --save @fortawesome/fontawesome-svg-core
npm install --save @fortawesome/free-solid-svg-icons
npm install --save @fortawesome/react-fontawesome
npm install react-datepicker --save
  1. Installing react-datepicker
npm install react-datepicker --save

Building the backend server 8. Go to the server directory in the terminal with:

cd server
  1. Build packages for Golang using:
go build
  1. Then run the following to connect to the database:
./run.sh

In Docker:

  1. Install/build Docker by following: https://docs.docker.com/get-started/
  2. Go the the client directory and run the following:
cd client 
docker build -t client
  1. Create a new terminal, go to the server directory, and run the following:
cd server 
docker build -t server

Running

In order to build the application in your IDE, run the following:

In the client directory

npm start

In the server directory

./run.sh

To run using Docker, run the following:

In terminal, run

docker run -p 3000:3000 client
docker run -p 8080:8080 server

Open http://localhost:3000 to view it in the browser.

How to use branching?

With Github Desktop

  1. Choose the branch you want to use
  2. Click pull origin
  3. Click the current branch and click new branch
  4. Type the name of the branch and click create branch

Contributors

Name GitHub
Nhien Lam @NhienLam
Tae Ho Lee @Lee-Taeho
Ekaterina Kazantseva @kate-kazantseva
Christine Lantaca @clantaca
Khang Nguyen @kharanga
Ayush Maheshwari @ayushmaheshwari768