This repository has been archived.

Repository contents won't be updated and issues/discussions won't be monitored.

We decided to continue to develop po8klasie respectively in:

• web-frontend repo
• po8klasie-fastapi repo

---

po8klasie

🇵🇱 Prawdopodobnie najprostsza i najszybsza wyszukiwarka szkół średnich.
Wkrótce produkcyjnie dostępna dla wszystkich!

🇬🇧 Probably the simplest and fastest high schools lookup service.
Soon available in production for everyone!

If you want to contribute to po8klasie, please read our contribution guide.

Quick start

NOTE: This project relies on Next.js Framework.

1. Clone this repo ⬇️

git clone https://github.com/po8klasie/po8klasie

2. In root directory of the project, create .env file with specified environmental variables (see below) 📄

3. Install dependencies using yarn 📦

yarn

4. Run the project 🚀

yarn start

5. Make some changes and submit pull request 🎉
   

NOTE: Before submitting a pull request, please read our contribution guidelines.

Environmental variables

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. If it's not specified, Open Street Map tiles are load.
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.

Linter & formatter

Available linter/formatter commands:

yarn lint:check
yarn format:check

yarn lint:fix
yarn format:write

What about the back-end?

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

Docs on how to develop front-end simultaneously with back-end locally coming soon!

Production use

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

More resources

• To learn more about Next.js Framework, go to Next.js website.
• To learn React, check out the React documentation.

Team & our partners

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

Our partners:

• City of Gdynia
• Moje Państwo Foundation
• SurveyLab