dis-course

A course discovery platform for University of Illinois students.

Requirements

Global Dependencies

• Node.js
• Yarn

For Docker

• Docker Desktop
• CLang/Make
  • macOS: xcode-select --install or install XCode Command-Line Tools
  • Aptitude: apt-get -y install make

Running Locally

Dockerized (Recommended Method)

The containerized method allows for quick setup of a local develop environment running the client, api, and database.

Ensure you have Docker Desktop Running

Usage

The included Makefile provides Docker command wrappings with rich output for the following arguments:

Spinning Up A Development Instance

make up

Shutting Down An Instance

make down

Force Container Rebuild

make build

Standalone

Standalone environments are great for working on a singular component of the application (e.g. the client) with little overhead.

Client (React App)

yarn && yarn start # install dependencies and start development environment

API (Express.js)

yarn && yarn start # install dependencies and start development environment

Contributing

Read more here.

Misc.

Helpful Tools

• React Dev Tools (for Firefox and Chrome)

---

Licensed under the GNU Affero General Public License

© 2021 Illinois Labs