Skip to main content
Learn how to set up your environment to run CinePro locally.

​
Before you start

Make sure you read the License section before using this project. This project is for personal and non-commercial use ONLY. Selling this project or adding tracking/advertisements is strictly prohibited.
⚠️This project is still in development.⚠️
Some features may not be fully implemented and are subject to change. Read more about the development process.
  • Windows
  • Linux
  • MacOS
  • Docker

Install Node and MongoDB

Make sure you have the following installed on your machine:
Install Node.js (v18 or higher) on your machine. You can download it from the official website or use winget to install it: winget install OpenJS.NodeJS.
Install MongoDB on your machine. You can download it from the official website or use winget to install it: winget install MongoDB.Server.
Make sure to run the MongoDB server (services.msc on Windows) before running the project.

Clone the repository

Clone the CinePro repository to your local machine using Git. Open your terminal and run the following command:
git clone https://github.com/cinepro-org/backend.git

Install dependencies

Navigate to the cloned repository directory and install the required dependencies using npm:
cd backend
npm i

Configure environment variables

Rename the .env_example file to .env and update the environment variables as needed. The .env file contains configuration settings for the CinePro application like API keys and debug settings.
Example .env file
TMDB_API_KEY="your key here"
PORT="3000"
DEBUG="off"
CinePro requires a TMDB API key to function properly. You can obtain a free API key by signing up on their website. Once you have the API key, add it to the .env file as TMDB_API_KEY.
The PORT variable is the port on which the server will run. You can change it to any available port if needed.
Make sure to switch DEBUG to off in the .env file for production use. This will disable debug logging. To enable debug logging, set DEBUG to true or 1.

Start the server

Run the following command to start the CinePro server:
npm run main
This will start the server, and you should see output indicating that the server is running.

Access the API

Congratulations! You have successfully set up CinePro. You can now access the API at http://localhost:3000.
Check out the API documentation for more information on how to use the API.
⌘I