Skip to content

Frontend for open-source Quotes app for viewing/saving/commenting on quotes

License

Notifications You must be signed in to change notification settings

EvalVis/QuotesFE

Repository files navigation

Quotes FE

GitHub - Check out the Backend

Main page

Main page

Saved quotes page

Saved quotes page

Functionality

  1. View random quotes shown on the main page
  2. See comments on the quotes. Comments are shown from the most recent.
  3. Login to:
    • Save quotes you like. Your quotes are displayed from most recently liked.
    • Forget your saved quotes you don't like anymore
    • Exclude your saved quotes from being shown as random quotes.
    • Comment on the quotes. Your comments are shown at the top.

Setup

This project uses Auth0 as authentication provider. The Quotes backend owner must setup the Auth0.

Environment variables

For project to run, several env variables are needed to be setup.

VITE_AUTH0_DOMAIN

Address where client authentication requests will be routed. Provided by Quotes backend owner. Already setup Auth0 domain: dev-wzfkg4o26oz6ndmt.us.auth0.com.

VITE_AUTH0_CLIENT_ID

Provided by Quotes backend owner. Already setup Auth0 client id: v0YzxpAoJP6tLyW29TnZEuqStYkUF5fY.

VITE_AUTH0_USE_REFRESH_TOKENS

Boolean - determines if user would be automatically logged in again after the short lived token expires. Optional: default value is false.

You can control refresh tokens if quotes backend owner has them enabled.

Currently setup Auth0 has refresh tokens enabled, however you can still disable them in your own frontend app.

VITE_AUTH0_AUDIENCE

Provided by Quotes backend owner. The already running project has value: quotes.programmersdiary.com.

VITE_BE_URL

URL of the Backend service which hosts the quotes. Currently running BE has value: https://quotesapi.fly.dev.

Running locally

npm install
npm run dev

Testing

To run the tests without execute:

npm test

To run tests with coverage:

npm run coverage

codecov

Hosting

Simplest way to host is to use vercel.com. It automatically detects app config and hosts the app on the cloud.

Vercel

Contributing

Please read a CONTRIBUTING.md file.

License

Please read a LICENSE file.

About

Frontend for open-source Quotes app for viewing/saving/commenting on quotes

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published