Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/city-of-helsinki/liikunta-helsinki
Liikunta Helsinki.
https://github.com/city-of-helsinki/liikunta-helsinki
Last synced: about 1 month ago
JSON representation
Liikunta Helsinki.
- Host: GitHub
- URL: https://github.com/city-of-helsinki/liikunta-helsinki
- Owner: City-of-Helsinki
- License: mit
- Created: 2021-05-06T09:22:11.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-11-16T04:43:27.000Z (about 1 year ago)
- Last Synced: 2024-04-08T16:42:27.787Z (9 months ago)
- Language: TypeScript
- Homepage:
- Size: 2.32 MB
- Stars: 1
- Watchers: 19
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Liikunta-helsinki
Liikunta-helsinki helps citizens find sports related content.
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
## Environments
Test: https://liikunta-helsinki.test.kuva.hel.ninja/
Production: https://liikunta.hel.fi
## Links
Issue board: https://helsinkisolutionoffice.atlassian.net/jira/software/c/projects/LIIKUNTA/boards/197
Sentry: https://sentry.io/organizations/city-of-helsinki/issues/?project=6160933
Codecov: https://app.codecov.io/gh/City-of-Helsinki/liikunta-helsinki
## Developing locally
Run the development server:
```
yarn install
cp .env.local.example .env.local
yarn dev
# or
docker-compose up
```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
## Available scripts
### `yarn dev`
Runs the application in development mode.
Open [http://localhost:3000](http://localhost:3000) to view in the browser.
The page will reload if you make changes.
### `yarn build`
Builds the production application in the `.next` folder.
Production build can be run locally with `yarn start`.
### `yarn test`
Launches the test runner in the interactive watch mode.
### `yarn get-translations`
Fetches translations from the CMS and generates translations files of them in `.json` format into `public/locales`.
### `yarn generate:graphql`
Generates hooks and types out of graphql queries. Check codegen.yml for current configurations.
## Environment variables
The following environment variables can be configured for this application.
Note that Next has some special behaviour when it comes to passing environment variables: https://nextjs.org/docs/basic-features/environment-variables
| Name | Description |
| --------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `NEXT_PUBLIC_CMS_GRAPHQL_ENDPOINT` | Headless-CMS GraphQL endpoint. |
| `NEXT_PUBLIC_UNIFIED_SEARCH_GRAPHQL_ENDPOINT` | Unified search GraphQL endpoint. |
| `NEXT_PUBLIC_NEXT_API_GRAPHQL_ENDPOINT` | GraphQL endpoint for the BFF of this application. |
| `NEXT_PUBLIC_ALLOW_UNAUTHORIZED_REQUESTS` | By toggling this variable, you may allow Apollo to handle requests without correct authorization. Our review environments do not have valid certificates (and won't), so we've allowed unauthorized request in them. Use with care! _**Default:** `false`_ |
| `NEXT_PUBLIC_DEBUG` | When toggled on, the application will produce more detailed logs. _**Default:** `false`_ |
| `NEXT_PUBLIC_HAUKI_ENABLED` | When this configuration is toggled on, Hauki related features are enabled. _**Default:** `false`_ |
| `NEXT_PUBLIC_MATOMO_ENABLED` | Control whether Matomo is enabled. |
| `NEXT_PUBLIC_MATOMO_SITE_ID` | If Matomo is in use, provide site id to direct analytics into the correct destination. |
| `NEXT_PUBLIC_DEFAULT_ISR_REVALIDATE_SECONDS` | Default length of time in seconds between [NextJS's ISR's](https://nextjs.org/docs/basic-features/data-fetching/incremental-static-regeneration) regenerations. _**Default:** `10`_ |
| `NEXT_PUBLIC_SENTRY_ENVIRONMENT` | Environment used for sentry logging |
| `NEXT_PUBLIC_SENTRY_DSN` | Sentry Data Source Name (DSN) [DSN Docs](https://docs.sentry.io/product/sentry-basics/dsn-explainer/) |
| `NEXT_PUBLIC_SENTRY_TRACE_SAMPLE_RATE` | Sentry sampling rate [Sampling Docs](https://docs.sentry.io/platforms/javascript/configuration/sampling/) |
| `SENTRY_AUTH_TOKEN` | Sentry authentication token when using Sentry CLI (Sentry uses this when building project for production) |
## Error tracking (Sentry)
Sentry is used for error tracking:
Sentry Next.js docs [here](https://docs.sentry.io/platforms/javascript/guides/nextjs/).
Sentry dashboard for this project [here](https://sentry.io/organizations/city-of-helsinki/issues/?environment=production&project=6078854).
## Internationalization
Translation files can be refreshed by running `yarn get-translations`.
Translations are sourced from the content management system.
The `next-i18next` library is used to distribute translations in the application. Required translations are marked with `serverSideTranslationsWithCommon` which automatically includes some common translations or with `serverSideTranslations` if the defaults are not useful.
## Briefly on architecture
This section covers what integrations this application has an briefly describes the backend-for-frontend, because these parts of the application may lie a bit farther out of from its core.
### Integrations
This application integrates into various services.
| Name | Description |
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| **Tprek** | Tprek is used as the main source of data for venues. When make direct calls to TPREK on the venue details page for instance. |
| **Liikunta CMS** | This headless CMS contains the data that defines menus, collections, SEO fields and more. |
| **Unified Search** | Unified Search provides an API we've used to build the search experience. It allows us to query for venues through a graphql endpoint. |
| **Linked Events** | Event related data is fetched from Linked Events. |
| **Hauki** | Hauki contains structured data of opening hours. Hauki related features have been disabled for now as Hauki hasn't been officially released yet. |
### Backend-for-frontend
This application provides a GraphQL endpoint that's used as a BFF.
It allows:
- Querying of venues by ids from the new TPREK API. Making equivalent queries directly into the TPREK API (any version) is not possible to our knowledge.
- Querying of events from Linked Events. The API is sightly different to conform with values we receive from the Headless-CMS (check usage for details). The implementation also contains a caching layer.
- Querying of a venue. Enriches the data from TPREK with ontology data and opening hours information from Hauki (when integration is enabled).
## Contact
City of Helsinki Slack channel #liikuntahelsinki