Welcome to the Movie Rating Ecosystem - MovieCrew! This ecosystem consists of various applications and components built around the core API, allowing friends in the same group to rate and keep track of the movies they watch together. This README will provide an overview of the different components and how they work together to enhance the movie-watching experience for your group.
MovieCrew is designed to create a collaborative and fun movie-watching experience for friends. The ecosystem consists of the following components:
-
Core API (C#/.NET): The heart of the ecosystem, managing user accounts, movie details, and ratings.
-
Web Application: A web-based front-end application that allows users to interact with the core API and access the platform's features through an intuitive and user-friendly interface.
-
Discord Bot Integration: A bot that can be added to the popular messaging platforms to provide quick access to movie details, group ratings, and movie recommendations.
Before starting the Movie Rating Platform - GroupWatch, ensure you have the following prerequisites:
- .NET Core SDK (at least version 3.1) for building and running the application locally.
- Docker installed on your machine if you want to run the application using Docker.
- MySQL server running with a database set up for the application (see database).
- Make sure your MySQL server is running, and you have created a database for the application.
- Configure the database connection in the appsettings.json file of your .NET Core application.
- Open a terminal at the root of the project and run the following commands:
cd MovieCrew.API
dotnet run
The application should now be running at http://localhost:5000 in your web browser.
- Open a terminal or command prompt, navigate to the root directory of your MovieCrew project (where the Dockerfile is located).
- Build the Docker image using the following command:
docker build -t movie-crew-app --build-arg CERT_PASSWORD=<your_password_here> .
- Run the Docker container:
docker run -d -p 443:443 --name movie-crew-container movie-crew-app
You can now access the MovieCrew application through your web browser using https://localhost. Since we generated a self-signed SSL certificate for localhost, your browser may show a security warning. You can proceed to the website by clicking "Advanced" or "Proceed" (depending on your browser).
Note : In production environments, it is recommended to use a properly signed SSL certificate issued by a trusted certificate authority (CA) to ensure secure communication with the application. Additionally, consider using environment-specific configuration files for better security and manageability when deploying the application to different environments.
For detailed information on the available API endpoints and their usage, refer to the API documentation.