Demo Spring React TODO App

Purpose

This app is a course project of https://ucsb-cs156.github.io, a course at UC Santa Barbara.

This repo is intended to be demonstration project of a relatively small app with a

• Spring Boot Backend
• React Front end
• Auth0 authentication using Google
• privilege levels "not logged in", guest, member and admin, where
  • guest means you've logged in, but with a non ucsb email address
  • member means you've logged in with a ucsb email address
  • admin means you are in the list of admins in the application.properties file, or else you've been added to the admins table by someone that's already an admin.

Getting Started

To get started with this application, you'll need to be able to

• Run it locally (i.e. on localhost)
• Deploy it to Heroku
• Get the test cases running on GitHub Actions
• See aggregrated code coverage statistics on Codecov

Instructions for each appear below in the setup steps

Integrations

This application has integrations with the following third-party services that require configuration

• Auth0.com (for authentication)
• Google (for authentication)
• A postgres database provisioned on Heroku

Setup

All of the setup steps for running the app on localhost and Heroku are described in these file:

• ./docs/SETUP-FULL.md if it is your first time setting up a Spring/React app with Auth0 and Google
• ./docs/SETUP-QUICKSTART.md if you've done these steps before.

Setting up GitHub Actions (CI/CD, CodeCov)

To setup GitHub Actions so that the tests pass, you will need to configure some secrets on the GitHub repo settings page; see: ./docs/github-actions-secrets.md for details.

This file also describes the setup for Codecov

Property file values

This section serves as a quick reference for values found in these files:

• application.properties
• secrets-localhost.properties
• secrets-heroku.properties

Property name	Heroku only?	Explanation
app.namespace		See Getting Started below
app.admin.emails		A comma separated list of email addresses of permanent admin users.
app.member.hosted-domain		The email suffix that identifies members (i.e. ucsb.edu vs gmail.com)
auth0.domain		See Getting Started below
auth0.clientId		See Getting Started below
security.oauth2.resource.id		Should always match app.namespace
security.oauth2.resource.jwk.keySetUri		Should always be https://${auth0.domain}/.well-known/jwks.json
spring.jpa.database-platform	Yes	Should always be org.hibernate.dialect.PostgreSQLDialect
spring.datasource.driver-class-name	Yes	Should always be org.postgresql.Driver
spring.jpa.properties.hibernate.temp.use_jdbc_metadata_defaults	Yes	Should always be false
spring.datasource.url	Yes	Should always be ${JDBC_DATABASE_URL}
spring.datasource.username	Yes	Should always be ${JDBC_DATABASE_USERNAME}
spring.datasource.password	Yes	Should always be ${JDBC_DATABASE_PASSWORD}
spring.jpa.hibernate.ddl-auto	Yes	Should always be update