ProCM

A blog & portfolio content management web application
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

ProCM is a robust web application serving as a platform for blogging. With user-friendly authentication and comment system, visitors can engage in lively discussions through comments on blog posts. Users have the added functionality of personalizing their profiles with an "About me" section, while administrators have access to an administration UI to manage the website.

(back to top)

Built With

• 
• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

In order to build and run the project you must have a JDK (Java 17) and Gradle installed.

• 
• 

Installation

1. Get a local database for testing (you can use the docker-compose.yml file in the backend)
2. Clone the repo

   git clone https://github.com/HyScript7/ProCM.git

3. Run or build the project

gradle bootrun # run spring app
gradle bootjar # compile to jar

(back to top)

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Roadmap

• Feature 1
• Feature 2
• Feature 3
  • Nested Feature

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

HyScript7 - @hyscript7 - hyscript7@gmail.com

Project Link: https://github.com/HyScript7/ProCM

(back to top)

Acknowledgments

• Best README Template

(back to top)