Welcome to the EasyOnlineShop repository, a REST API built with Spring Boot 3, Maven, and Java 17.
Before you begin, make sure you have installed:
- JDK 17
- Maven
- MySQL
To contribute or use this project in your local environment, you can fork this repository and then clone it using the following command:
git clone https://github.com/TerronesDiaz/easyOnlineShopApiRest.gitBefore running the application, create a MySQL database named easyOnlineShop or configure the database connection properties in src/main/resources/application.properties as you prefer:
spring.datasource.url=jdbc:mysql://localhost:3306/easyOnlineShop?createDatabaseIfNotExist=true
spring.datasource.username=root
spring.datasource.password=root
If the project includes Maven Wrapper, you can run the application without needing Maven installed. In your terminal, use the following command:
./mvnw spring-boot:runOn Windows, if you are using CMD, you might need to omit ./ before the command.
The application will start and be available at http://localhost:8090.
The documentation for the endpoints is available once the REST API is running at http://localhost:8090/public/doc/swagger-ui/index.html.
To access the protected EndPoints, you first need to register or log in to obtain the token from the response of these public EndPoints:
Then, you need to click on the lock button that says 'Authorize' if you want to use the token for all requests, or on the gray lock button if you only wish to apply it to a specific EndPoint. This will allow you to access the other requests that are not public and avoid the 403 error.
If you want to contribute to the project, please follow these steps:
- Fork the repository.
- Make your changes in a new branch.
- Submit a pull request for your changes to be reviewed and integrated into the main project.
This project is under the [MIT License].
Thank you for using and contributing to EasyOnlineShop.