Getting Started - BruGeth/Cinerama GitHub Wiki
🚀 Getting Started with Cinerama
This guide will help you get Cinerama up and running on your system quickly.
Prerequisites
Before you begin, ensure you have the following installed:
- Java 17 (JDK)
- Maven (3.6+ recommended)
- Node.js (v16.0 or higher) and npm
- MySQL (8.0+ recommended)
- Git for version control
Quick Installation
1. Clone the Repository
git clone https://github.com/BruGeth/Cinerama.git
cd Cinerama
git checkout develop
2. Backend Setup
Navigate to the backend directory and install dependencies:
cd backend
mvn clean install
3. Database Configuration
Create the application-local.yml
file in backend/src/main/resources/
:
spring:
datasource:
url: jdbc:mysql://localhost:3306/cinerama_db
username: your_mysql_username
password: your_mysql_password
driver-class-name: com.mysql.cj.jdbc.Driver
jpa:
hibernate:
ddl-auto: update
show-sql: true
properties:
hibernate:
dialect: org.hibernate.dialect.MySQL8Dialect
jwt:
secret: your_jwt_secret_key_here
expiration: 86400000
4. Start the Backend
cd backend
mvn spring-boot:run
The backend will run on http://localhost:8080
5. Frontend Setup
In a new terminal, navigate to the frontend directory:
cd frontend
npm install
npm start
The frontend will run on http://localhost:3000
Visit http://localhost:3000
to see Cinerama in action!
Next Steps
- Configure your system for production use
- Explore the API Reference for integration
- Check out our FAQ for common questions
Troubleshooting
Having issues? Check our FAQ or create an issue on GitHub.