ChangeLogs

A simple application to manage a common requirement in our application development process: ** Keep users up to date on our changes! **

NOTE 1: This Application is under development, and isn't ready for production purpose.

NOTE 2: You can find front part in this repository: https://github.com/GLinBoy/changelogs-frontend

Summary

• Getting Started
• Running the tests
• Deployment
• Built With
• Contributing
• Versioning
• Authors
• License
• Acknowledgments

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

ChangeLogs needs only Java 17 and Maven to run or build; The project also include Maven wrapper but you can use local Maven too;

Running from the source

1. clone the project on your system:

   git clone https://github.com/GLinBoy/changelogs-backend.git

2. go to the ChangeLogs directory

   cd changelogs-backend

3. Run application with Maven or use Maven Wrapper:

   ./mvnw

Installing

Please, let me finish project and then give you installation instructions 😊

Running the tests

Run this command on root of project:

./mvnw clean test

Break down into end to end tests

I didn't develop any test for project, YET, but I will add tests as soon as possible.

And coding style tests

I didn't develop any test for project, YET, but I will add tests as soon as possible.

Deployment

It's like any Spring Boot application If you been familiar with them, creating a JAR file then run it on your production server, otherwise please check Installing section.

Built With

• Java - Main Development language, used version 17
• Spring Boot - For IOC and loose coupling
• Maven - for dependency management and build tools

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Hojjat Abedi - GLinBoy

License

This project is licensed under the GNU GPLv3 License - see the LICENSE.md file for details

Acknowledgments

This section filled by your question 😊