Code Monkey home page Code Monkey logo

gradestats-app's Introduction

Gradestats webapp

This project serves as the front-end for gradestats, separate from the api which is its own project.

Live version can be found at grades.no

Getting Started

First, run the development server:

# Install dependencies
npm i

# Run development server
npm run dev

Open http://localhost:3000 with your browser to see the result.

Environment

Are you adding environment variables?

Variables have to be added in a lot of places to make everything work correctly!

  1. Add them to the /common/constants file where they are used. Here you can also add defaults.
  2. Add them to the Dockerfile to make them available to production.
  3. Add the variables to the secrets in the github repository, which is where we store variables for production.
  4. Proxy the variables in the required github actions files.
  5. Add them to the list of variables below to make it easier to keep track for everyone involved.

Private variables

Private variables have to be set in the runtime environment to be kept private.

List of variables

# How many courses should be pre-rendered at build time
NEXT_PUBLIC_BUILD_TIME_COURSE_LIMIT # Default = 100
# Base url of the api backend
NEXT_PUBLIC_GRADES_API_URL # Default = https://grades.no, for local backend it should be 'http://localhost:8000'
# Sentry url/id for error logging
NEXT_PUBLIC_SENTRY_DSN # Default = undefined
# Google analytics tracking ID
NEXT_PUBLIC_GA_TRACKING_ID # Default = __REPLACE_ME__
# Actual URL of the hosted project. Important for linking. for prod it should be https://grades.no
NEXT_PUBLIC_CANONICAL_URL # Default = http://localhost:3000
# Redirect url for next auth
NEXTAUTH_URL #
# Client ID for dataporten/FEIDE client for OIDC
NEXT_PUBLIC_FEIDE_CLIENT_ID # Default = undefined
# Client Secret for dataporten/FEIDE client for OIDC. HAS TO BE KEPT SECRET
NEXT_PRIVATE_FEIDE_CLIENT_SECRET # Default = undefined
# Base url for OIDC authentication (for auto discovery)
NEXT_PUBLIC_FEIDE_AUTH_ENDPOINT # Default = https://auth.dataporten.no

gradestats-app's People

Contributors

oleast avatar dotkom-build avatar fluidsense avatar kharann avatar dependabot[bot] avatar henrikskog avatar aslakhol avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.