Skip to content

informatyzacja/parliamentary-system

Repository files navigation

System Parlamentarny

GitHub Workflow Status Crowdin translation status GitHub package.json version Uptime ratio API uptime ratio License

Aplikacja webowa do przekazywania dokumentów Parlamentu Studenckiego.

Tech Stack

api: Strapi

web: Next, React, Chakra UI, Emotion, TypeScript

Ogólne: Docker, GitHub Actions, GraphQL

Environment Variables

Do uruchomienia projektu niezbędne jest uruchomienie poniższego kodu oraz ustawienie poniższych zmiennych

cp .env.example .env && cp api/.env.example api/.env && cp web/.env.example web/.env

.env

  • DATABASE_NAME
  • DATABASE_USERNAME
  • DATABASE_PASSWORD
  • DATABASE_FOLDER

api/.env

  • USOS_CLIENT_ID
  • USOS_CLIENT_SECRET

gdzie klucze do USOS uzyskasz od swojej uczelni

  • DATABASE_NAME
  • DATABASE_USERNAME
  • DATABASE_PASSWORD

tak samo jak wyżej w .env

  • WEB_URL - url frontendu

web/.env

  • NEXT_PUBLIC_API_URL - url backendu
  • NEXTAUTH_URL - url frontendu
  • NEXTAUTH_SECRET - losowo wygenerowany sekret
  • GOOGLE_CLIENT_ID - Google OAuth client id
  • GOOGLE_CLIENT_SECRET - Google OAuth secret token
  • USOS_CLIENT_ID
  • USOS_CLIENT_SECRET

tak samo jak wyżej w api/.env

Instalacja

Wykonaj poniższe polecenia

git clone https://github.com/informatyzacja/parliamentary-system.git
cd parliamentary-system
yarn install --immutable
turbo dev

Deployment

Aby dokonać deployu projektu uruchom podane poniżej polecenia

docker compose -f docker-compose.yml up --force-recreate -V

Contributing

Zgłaszanie błędów mile widziane!

Projekt jest prowadzony przez wyznaczone osoby i nie przyjmuje na ten moment PR z zewnątrz.