Welcome to the My Big Whale API project! Our team, passionate about developing software that generates a positive impact on customers, has been dedicated to developing an API focused on manipulating different files in a simple and efficient way. This README will provide all the information necessary to understand how the API works and test requests.
The My Big Whale API allows developers and users to easily integrate editing functionality into their projects, ensuring a unique and productive experience. We are constantly striving to improve and expand the My Big Whale API, ensuring it is the ideal choice for increasing creativity and file manipulation success in your applications
Here are the main technologies by type used in the project:
Make sure you have the following tools installed before you begin:
- Java Development Kit (JDK) 17
- Spring Boot
- Maven
# Clone the repository
git clone https://github.com/ProjectBIGWHALE/bigwhale-api/
# Enter the backend project folder
cd bigwhale-api
# Compile the project source code
mvn clean package
# Run the project
java -jar target/whale-api.jar
# The server will be available in http://localhost:8080/
There are tools that easily allow you to build interaction interfaces with your API, in order to test functionalities quickly and without the need to create code. We then chose to use Swagger.
After performing the steps in the Confgurations section, access our API's interactive documentation at:
To help identify issues, optimize performance, and maintain the reliability of our web application in production, we chose Prometheus to collect, store, and process metrics, and Grafana to visualize those metrics in an effective and interactive way Together, these tools play a key role in monitoring and observability of web applications.
If you encounter any issues or have suggestions for improving the API, please read contributions.md for details on the process for sending us solicitation requests.
E-mail: contact@mybigwhale.com
Distributed under the MIT License. See LICENSE for more information.
