maciejkopec.pl

Hobby project to explore modern Java capabilities. My personal simple portfolio built with Spring Boot

Feel free to use it any part from this repository.

🚀 Quick start

1. Clone.

   Clone this repository.

   git clone https://github.com/maciejkopecpl/cms.git
   

2. Build.

   Build the application.

   cd cms/
   gradle build

3. Run

   Now you should be able to run the application.

   ./gradlew bootRun

🧐 What's inside?

A quick look at the top-level files and directories.

.
├── gradle/wrapper
├── src
├── .gitignore
├── Dockerfile
├── LICENSE
├── Procfile
├── README.md
├── build.gradle
├── docker-compose.yml
├── empty.env
├── gradlew
├── gradlew.bat
├── intellij-java-google-style.xml
├── lombok.config
├── settings.gradle
└── system.properties

1. /gradle/wrapper: This directory contains Gradle wrapper.

2. /src: This directory will contain all of the code. src is a convention for “source code”.

3. .gitignore: This file tells git which files it should not track / not maintain a version history for.

4. Dockerfile: This file contains all the commands to assemble an image.

5. LICENSE: This project is licensed under the MIT license.

6. Procfile: This is a build configuration file for Heroku cloud.

7. README.md: A text file containing useful reference information about this project.

8. build.gradle: A Gradle file containing details about dependencies and compile details for this project.

9. docker-compose.yml: A Docker compose file containing definition fo multi-container docker application.

10. empty.env: A empty file containing all required environment variables.

11. gradlew: A Gradle batch script for executing the build with the Wrapper.

12. gradlew.bat: A Gradle batch script for executing the build with the Wrapper.

13. intellij-java-google-style.xml: A file containing Google Style for IntelliJ.

14. lombok.config: A file containing Lombok configuration.

15. settings.gradle: A file containing Gradle settings.

16. system.properties: A file containing system configuration for Heroku cloud.

🏪 Frontend

The frontend application that uses these backend services is available here CMS UI.

👨‍⚖️ License

MIT