LinkShorter

This is a URL shorter like bit.ly and etc.

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

Summary

• Getting Started
• Runing 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

LinkShorter needs only Java 15 and Gradle to run or build; The project also include Gradle wrapper but you can use local Gradle too;

Runing from the source

1. clone the project on your system:

   git clone https://github.com/GLinBoy/linkshorter.git

2. go to the linkshorter directory

   cd linkshorter

3. Run application with Maven or use Maven Wrapper:

   ./gradlew

Installing

Please, Lemme finish project and then give you installation instructions 😊

Running the tests

Run this command on root of project:

./gradlew 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 familar 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 15
• Spring Boot - For IOC and loos copeling
• Gradle - 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 MIT License - see the LICENSE.md file for details

Acknowledgments

This section filled by your question 😊