README.md

proj-courses-s23-7pm-1

This repo contains the code for the CMPSC 156 legacy code project "Courses Search".

The project provides a web application where users can search for UCSB courses in various ways.

Users with a Google Account can also store past, current or future schedules of courses for particular quarters.

Deployments

Type	Link
prod	https://proj-courses.dokku-09.cs.ucsb.edu/
qa	https://proj-courses-qa.dokku-09.cs.ucsb.edu/

Setup before running application

Before running the application for the first time, you need to do the steps documented in docs/oauth.md.

Otherwise, when you try to login for the first time, you will likely see an error such as:

Getting Started on localhost

• Open two separate terminal windows
• In the first window, start up the backend with:

  mvn spring-boot:run
  

• In the second window:

  cd frontend
  npm install  # only on first run or when dependencies change
  npm start
  

Then, the app should be available on http://localhost:8080

If it doesn't work at first, e.g. you have a blank page on http://localhost:8080, give it a minute and a few page refreshes. Sometimes it takes a moment for everything to settle in.

If you see the following on localhost, make sure that you also have the frontend code running in a separate window.

Failed to connect to the frontend server... On Heroku, be sure that PRODUCTION is defined.  On localhost, open a second terminal window, cd into frontend and type: npm install; npm start";

Getting Started on Heroku

On Heroku, you'll need to set the following configuration variable:

• Using the Heroku CLI:

  heroku config:set PRODUCTION=true --app <heroku app name>
  

• Or set it on the Heroku Dashboard:

You'll also need to follow the OAuth set up instructions here: docs/oauth.md.

If you get the following message on Heroku, it probably means that you failed to setup the PRODUCTION environment variable.

Failed to connect to the frontend server... On Heroku, be sure that PRODUCTION is defined.  On localhost, open a second terminal window, cd into frontend and type: npm install; npm start";

Additional environment variables that are needed may be found in .env.SAMPLE

In particular, you will need a value for the UCSB_API_KEY. This is documented in docs/ucsb_api_key.md

Accessing swagger

To access the swagger API endpoints, use:

• http://localhost:8080/swagger-ui/index.html

To run React Storybook

• cd into frontend

• use: npm run storybook

• This should put the storybook on http://localhost:6006

• Additional stories are added under frontend/src/stories

• For documentation on React Storybook, see: https://storybook.js.org/

Accessing Database Console

• On localhost only: http://localhost:8080/h2-console See also: docs/h2-console.md
• On Heroku, with CLI:

  • Use: heroku psql --app app-name-here

  • Note that this requires that you have the psql CLI tool installed on your system.

  • This does work on CSIL, but you may need heroku login -i in order to login on CSIL

  • Example:

    [pconrad@csilvm-03 ~]$ heroku psql --app demo-spring-react-example
    ›   Warning: heroku update available from 7.59.1 to 7.59.2.
    --> Connecting to postgresql-tapered-84555
    psql (13.4, server 13.5 (Ubuntu 13.5-2.pgdg20.04+1))
    SSL connection (protocol: TLSv1.3, cipher: TLS_AES_256_GCM_SHA384, bits: 256, compression: off)
    Type "help" for help.
    
    demo-spring-react-example::DATABASE=> 
    

• On Heroku, without CLI:

  • Upper right of dashboard, select "More" then "Run Console"

    

  • Enter psql $DATABASE_URL and click Run

    
• Cheatsheet of psql commands: https://www.geeksforgeeks.org/postgresql-psql-commands/