README.md

CampusPlus

Table of Contents

• About
• Prerequisites
• Installation
  • Deploy via local network or w/ AWS Tools
• Additional configuration

About

What is CampusPlus?

• Similar to Canvas/eCampus, CampusPlus is a education website that enables students to stay up to date w/ assignments, managing courses, reviewing forums, & more! **Can be deployed locally or via an AWS server!

Prerequisites

• Docker v19.03.13 or higher
• Docker-compose v1.27.4 or higher
• Node.js v16.15.1 or higher
• npm v6.14.9 or higher
• yarn v1.22.5 or higher

Installation

Option 1: Deploying local database + API to docker containers (local)

1. Deploy Frontend & Backend (Using Docker) ➡ $ docker-compose up

• or Backend ONLY ➡ $ cd CampusPlus/backend; yarn run dev
• or Frontend ONLY ➡ $ cd CampusPlus/frontend; yarn start

Option 2: Deploying RDS cloud database + API to docker containers (EC2 Linux Instance)

1. AWS Management Console
2. Create RDS MySQL Database
3. Create EC2 Linux Instance
4. Install the following within EC2 Linux Instance:

• Node.js + npm + yarn
• Docker + Docker-Compose
• clone project repository

6. Within the CampusPlus/backend folder, create .env file & enter cloud database credentials :

MYSQL_DB=
MYSQL_PORT=
MYSQL_CLOUD_USER=
MYSQL_CLOUD_PASS=
MYSQL_CLOUD_HOST=

7. Deploy Frontend & Backend (Using Docker) ➡ $ docker-compose up

• or Backend ONLY ➡ $ cd CampusPlus/backend; yarn run dev
• or Frontend ONLY ➡ $ cd CampusPlus/frontend; yarn start

Additional configuration