Skip to content

Latest commit

 

History

History
72 lines (43 loc) · 1.89 KB

README.md

File metadata and controls

72 lines (43 loc) · 1.89 KB
Raw

College Resources

The website of College Resources

The go-to place for all your college needs. From course notes and previous exams to grades and feeding schedules.

See college-resources/api for the API of this website.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites (Windows)

  1. NodeJS 14.X (Recommended version: NodeJS 14.16.0 x64)

  2. Git for Windows

Prerequisites (Linux)

  1. NVM (Node Version Manager)

  2. Git for Linux

Downloading

Navigate to the folder where you want the project to be saved and run the following command:

git clone https://github.com/college-resources/web.git

Preparing

  1. Navigate to the root of the project.

  2. (Linux) Run nvm use.

  3. Run npm install.

  4. Create a .env file in the root of the project and add the following details:

AUTH0_DOMAIN=<YOUR_AUTH0_DOMAIN>
AUTH0_CLIENT_ID=<YOUR_AUTH0_CLIENT_SECRET>
AUTH0_CLIENT_SECRET=<YOUR_AUTH0_CLIENT_SECRET>
AUTH0_AUDIENCE=<YOUR_AUTH0_AUDIENCE>
AUTH0_SCOPE=openid email profile offline_access
AUTH0_REALM=<YOUR_AUTH0_REALM>

API_ADDRESS=<COLLEGE_RESOURCES_API_ADDRESS>

Running

Development

  1. In the root of the project run npm run dev.

  2. Wait for it to compile and click the http://localhost:3000 link when it appears.

Production

  1. In the root of the project run
npm run build
npm start
  1. When the server starts, go to http://localhost:3000