Overview

System Parlamentarny is a web application designed for transmitting documents within a student parliament. It is built using a tech stack that includes Strapi for the API, Next.js and React for the web interface, and Chakra UI and Emotion for styling. The application also utilizes Docker and GitHub Actions for development and deployment processes, as well as GraphQL for data querying.

Features

• Document transmission: The web application allows users to easily transmit documents within the student parliament.
• User authentication: System Parlamentarny provides secure user authentication, ensuring that only authorized users can access and interact with the application.
• Integration with USOS: The application integrates with USOS (University Studies Objective System) to obtain client IDs and secrets for authentication purposes.

Installation

To install and run the project, follow these steps:

1. Clone the project repository from GitHub.
2. Set up the required environment variables by creating a “.env” file in the “api/” directory. Include the following variables:

DATABASE_NAME
DATABASE_USERNAME
DATABASE_PASSWORD
DATABASE_FOLDER
USOS_CLIENT_ID
USOS_CLIENT_SECRET

Note: Obtain the USOS client ID and secret from your educational institution.

3. Set up the environment variables for the web interface by creating a “.env” file in the “web/” directory. Include the following variables:

WEB_URL
NEXT_PUBLIC_API_URL
NEXTAUTH_URL
NEXTAUTH_SECRET
GOOGLE_CLIENT_ID
GOOGLE_CLIENT_SECRET
USOS_CLIENT_ID
USOS_CLIENT_SECRET

Note: Use the same values for the USOS client ID and secret as in the “api/.env” file.

4. Execute the necessary commands for deployment. (Details not provided in the content.)

Summary

System Parlamentarny is a web application designed for document transmission within a student parliament. It employs a modern tech stack including Strapi, Next.js, React, Chakra UI, Emotion, and TypeScript. The application provides features such as document transmission and user authentication, as well as integration with USOS for authentication.