Skip to content

Latest commit

 

History

History
139 lines (88 loc) · 3.63 KB

README.md

File metadata and controls

139 lines (88 loc) · 3.63 KB
Raw

DTP-STAT

Future frontend of https://dtp-stat.ru written in Next.js.

Getting Started

  1. Install dependencies:

    yarn install

  2. Create a file named .env.local and fill it with environment variables listed in the next section.

  3. Generate Prisma typings:

    yarn prisma generate

  4. Run Next.js in dev mode:

    yarn dev

  5. Open localhost:3000 in your browser to see the result.

Environment variables

All secrets should never be committed to the git repo, but saved in the environment variables.

Transition from Django

Classic version of dtp-stat.ru runs on Django framework. Its source is stored in dtpstat/dtp-stat (internal link). While we transition to Next.js, we still need Django app to serve API requests and missing pages.

DJANGO_BASE_URL={url}
DJANGO_CONTENT_FALLBACK={true | false}

Enabling DJANGO_CONTENT_FALLBACK makes Next.js route all non-existing resources to Django. This enables incremental adoption of Next.js, allowing us to convert pages to React one by one. See next.config.mjs → rewrites for implementation details.

Content management

COMMENTS_ARE_PAUSED={true | false}

Error tracking

This app uses Sentry to track runtime errors both on client and server. Error reporting is disabled by default. For it to work for a deployment, configure these variables before running yarn build.

SENTRY_AUTH_TOKEN={token}
SENTRY_DSN={url}
SENTRY_ENVIRONMENT={production | staging | ...}

Authorization with auth0

  1. Create new application on the auth0

  2. Go to the auth0 application configuration page

  3. Set Application URIs.

    Values below are for local development on http://localhost:3000 and deployments to https://dtp-map.netlify.app / https://*--dtp-map.netlify.app.

    Allowed Callback URLs:

    http://localhost:3000/api/auth/callback, https://dtp-map.netlify.app/api/auth/callback, https://*--dtp-map.netlify.app/api/auth/callback

    Allowed Logout URLs:

    http://localhost:3000, https://dtp-map.netlify.app, https://*--dtp-map.netlify.app

    Allowed Web Origins:

    http://localhost:3000, https://dtp-map.netlify.app, https://*--dtp-map.netlify.app

  4. Get the auth0 application values: DOMAIN, CLIENT_ID, CLIENT_SECRET

  5. Define these environment variables in .env.local, Netlify UI, etc.:

    AUTH0_CLIENT_ID={client-id}
AUTH0_CLIENT_SECRET={client-secret}
AUTH0_ISSUER_BASE_URL={url}
AUTH0_SECRET={secret}

    For local development you will also need to set AUTH0_BASE_URL=http://localhost:3000. This variable is automatically configured for Netlify deployments via build-on-netlify.mjs.

Database Configuration

  1. Create any prisma-supported database any localhost or online (tested with Heroku/PostgreSQL).

  2. Define this environment variable in .env.local, Netlify UI, etc.:

    DATABASE_URL="postgres://{user}:{password}@{host}:{port}/{db}"

Database Schema Update

Initial apply of the db schema:

yarn prisma generate
yarn prisma db push

On every change of the file schema.prisma please run:

yarn prisma db push

On every change of the raw database schema please run:

yarn prisma db pull

Contributing

How to contribute