/po8klasie

Probably the simplest and the fastest app for high schools lookup

Primary LanguageTypeScriptGNU General Public License v3.0GPL-3.0

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

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

  2. Install dependencies using yarn 📦

yarn
  1. Run the project 🚀
yarn start
  1. 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

Currently, we are in process of setting up eslint and prettier.

Available linter/formatter commands:

yarn lint:check
yarn format:check
 
# please don't use commands below for now
# they modify files across the project
yarn format:write
yarn lint:fix

NOTE: Please make sure there are no linted/formatted files out of scope of your work before submitting PR

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

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: