The Dream project is a backend application developed using Spring Boot that provides endpoints for storing dream stories and performing CRUD (Create, Read, Update, Delete) operations on these stories. It serves as the backend service for managing dream stories.
- CRUD Operations: The project supports Create, Read, Update, and Delete operations for dream stories.
- RESTful API: It exposes RESTful endpoints to interact with dream stories.
- Persistence: Dream stories are stored in a database, ensuring data durability and reliability.
- Spring Boot: Framework for building Java-based applications, providing features like auto-configuration and embedded web server.
- Spring Data JPA: Simplifies database interactions and provides repository support.
- Hibernate: ORM (Object-Relational Mapping) framework for mapping Java objects to database tables.
- MySQL: Relational database management system for storing dream stories.
- Maven: Dependency management tool for managing project dependencies and building the project.
To set up and run the Dream project locally, follow these steps:
-
Clone the Repository: Clone the Dream project repository from GitHub:
git clone https://github.com/yourusername/dream-project.git -
Configure the Database: Update the database configuration properties in
application.propertiesfile with your MySQL database credentials:spring.datasource.url=jdbc:mysql://localhost:3306/dream_db spring.datasource.username=your_username spring.datasource.password=your_password
-
Build the Project: Navigate to the project directory and build the project using Maven:
cd dream-project mvn clean install -
Run the Application: Run the Spring Boot application using Maven:
mvn spring-boot:run -
Access the API: The application will start running on
http://localhost:8080. You can access the API endpoints using tools like Postman or any HTTP client.
- GET /api/dreams: Retrieve all dream stories.
- GET /api/dreams/{id}: Retrieve a specific dream story by its ID.
- POST /api/dreams: Create a new dream story.
- PUT /api/dreams/{id}: Update an existing dream story.
- DELETE /api/dreams/{id}: Delete a dream story by its ID.
Contributions to the Dream project are welcome! If you encounter any issues or have suggestions for improvement, feel free to open an issue or submit a pull request.