po8klasie web frontend

🇵🇱 Prawdopodobnie najprostsza i najszybsza wyszukiwarka szkół średnich.

🇬🇧 Probably the simplest and fastest high schools lookup service.

Quick start

NOTE: This project relies on Next.js Framework.

git clone https://github.com/po8klasie/web-frontend

In root directory of the project, create .env file with specified environmental variables (see below) 📄
Install dependencies using yarn 📦

yarn

yarn dev

Name	Required	Description
`API_URL`	✔️	Url where the API is hosted (do NOT include a trailing slash)
`APP_ENVIRONMENT`	❌	e.g. `production`, `test`. It's used by Sentry and displayed in the footer.
`APP_FRONTEND_RELEASE`	❌	e.g. docker image tag. It's used by Sentry and displayed in the footer.
`MAPBOX_ACCESS_TOKEN`	✔️	Mapbox access token. (We'll be adding OSM support soon)
`PUBLIC_SENTRY_DSN`	❌	Sentry DSN. If it's not specified, Sentry client is not initialized.
`POSTHOG_API_KEY`	❌	Posthog API key. If it's not specified, Posthog Analytics client is not initialized.

NOTE: If you don't want to spin up local API server, for development purposes use https://test.po8klasie.pl/api as API_URL.

Available linter/formatter commands:

yarn lint:check
yarn format:check

yarn lint:fix
yarn format:write

If you want to develop front-end only, you are good to go! Just insert URL of the API server in .env file.

If you want to develop front-end simultaneously with back-end:

We publish versioned ghcr.io/po8klasie/web-frontend docker image. Remember to set up env vars according to "Environmental variables" section.

You can find detailed guide of how to set up po8klasie for production use in our infra repo.

This is a civic tech and open-source project crafted by volunteers. Core team members are listed on po8klasie.pl website.

Our partners:

Name		Name	Last commit message	Last commit date
Latest commit History 72 Commits
.github		.github
.yarn		.yarn
public		public
src		src
.dockerignore		.dockerignore
.editorconfig		.editorconfig
.eslintignore		.eslintignore
.eslintrc.js		.eslintrc.js
.gitignore		.gitignore
.prettierignore		.prettierignore
.prettierrc.js		.prettierrc.js
.yarnrc.yml		.yarnrc.yml
Dockerfile		Dockerfile
LICENSE		LICENSE
README.md		README.md
docker-compose.ci.yml		docker-compose.ci.yml
entrypoint.tests.sh		entrypoint.tests.sh
jest.config.js		jest.config.js
next-env.d.ts		next-env.d.ts
next-i18next.config.js		next-i18next.config.js
next.config.js		next.config.js
package.json		package.json
postcss.config.js		postcss.config.js
sentry.client.config.ts		sentry.client.config.ts
sentry.server.config.ts		sentry.server.config.ts
server.js		server.js
tailwind.config.js		tailwind.config.js
tsconfig.json		tsconfig.json
yarn.lock		yarn.lock