Cinetiq

Cinetiq is an application designed to help film festival staff organize and plan their festivals. With Cinetiq, users can manage content such as films, series, and exhibitions, as well as handle details for various individuals involved in the festival, including film guests, accredited professionals, press representatives, and more.

Visit Cinetiq

Features

• Content Management: Add and manage films, series, and exhibitions.
• Person Management: Create and manage profiles for all individuals involved in the festival, including film guests, accredited professionals, press representatives, and more.

Technologies Used

• Backend: Java, Spring Boot, Lombok
• Frontend: TypeScript, React, Vite, Chakra UI
• Database: MongoDB, Mongock for database migrations
• State Management: Zustand
• Routing: React Router
• HTTP Client: Axios
• Authentication: OAuth2 with GitHub
• Containerization: Docker (used in CI/CD with GitHub Actions)
• Testing: JUnit, Jest, React Testing Library, MockWebServer
• Logging: Better Stack
• Static Analysis: SonarCloud

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Make sure you have the following installed:

• Java JDK 22
• Node.js
• MongoDB

Installation

Backend Setup with IntelliJ IDEA:

1. Clone the repository directly in IntelliJ IDEA:

   • Open IntelliJ IDEA.
   • Select File -> New -> Project from Version Control.
   • In the dialog that appears, enter the URL of the repository:

     https://github.com/josch87/Cinetiq.git

   • Click Clone.

2. Set up the development properties file:

   • Navigate to backend/src/main/resources in the Project tool window.
   • Copy application-development.properties.sample and rename the copy to application-development.properties.
   • Open application-development.properties and fill in the required values.

3. Import the Maven project:

   • IntelliJ IDEA should automatically detect the pom.xml file in the backend directory and prompt you to import the Maven project. If not, right-click on the pom.xml file and select Add as Maven Project.

4. Run the Spring Boot application using IntelliJ run configuration:

   • The BackendApplication run configuration is pre-configured in the .run folder.
   • Open the Run/Debug Configurations dialog (Run -> Edit Configurations).
   • Select the BackendApplication configuration and click Run.

Frontend Setup:

1. Navigate to the frontend directory:

   cd frontend

2. Install dependencies:

   npm install

3. Start the Vite development server using IntelliJ run configuration:
   • The FrontendApplication run configuration is pre-configured in the .run folder.
   • Open the Run/Debug Configurations dialog (Run -> Edit Configurations).
   • Select the FrontendApplication configuration and click Run.

Running the Application

• Ensure MongoDB is running on your machine.
• Start the backend server:
  • Follow the steps in the Backend Setup section to run the Spring Boot application using the IntelliJ run configuration.
• Start the frontend server:
  • Follow the steps in the Frontend Setup section to start the Vite development server using the IntelliJ run configuration.
• Open your web browser and go to http://localhost:5173 to access Cinetiq.

Running Tests and Applications

In IntelliJ IDEA, you can run the following operations using pre-configured run configurations located in the .run folder in the root directory:

• Frontend Tests: Execute the FrontendTests configuration to run frontend tests.
• Backend Tests: Execute the BackendTests configuration to run backend tests.
• Backend Tests (Coverage): Execute the BackendTests (Coverage) configuration to run backend tests with coverage analysis.
• Backend Application: Execute the BackendApplication configuration to start the backend application.
• Frontend Application: Execute the FrontendApplication configuration to start the frontend application.

GitHub API Integration

• Scheduled Data Retrieval: GitHub API is integrated into the backend to retrieve data periodically from registered GitHub users within the application using scheduling.

Credits

• Development: Aljoscha Zöller
• Logo Design: Nastassia Volkus

Special Thanks

• Florian Weber
• Elvedin Turkovic
• Martin Pagels

Thanks to the open-source community for the tools and frameworks used in this project.

Contact

For any inquiries or questions, feel free to contact me at web.aljoschazoeller.com.