Welcome to the API documentation for Project Name. This document provides detailed information about the API endpoints, how to run the application, and other important instructions.
For detailed API documentation, please refer to the HTML Documentation. It includes the following information:
a. Before anything, create a file called .env
in the root directory of the project and paste the data sent to you via email. Then proceed to other instructions.
- Swagger Page URL:
https://localhost:8200/swagger-ui.html
- Swagger Docs URL:
https://localhost:8200/v2/api-docs
- Command to Run the Application:
mvn spring-boot:run
- Instruction to Create Database:
CREATE DATABASE test_db;
- Instruction to Access Postman API Collection: Import Postman collection from
/postman
folder in the project root directory. - Start the App (Linux Command):
sudo chmod +x .start.sh && sh start.sh
- Stop the App (Linux Command):
sudo chmod +x .stop.sh && sh stop.sh
- Java Development Kit (JDK)
- Apache Maven
- Postman (for testing API endpoints)
- MySQL Database Server
- Clone the repository:
git clone https://github.com/demoxie/payment-service.git
- Navigate to the project directory:
cd payment-service
- Follow the instructions in the HTML documentation to set up and run the application.
If you would like to contribute to this project, please follow these steps:
- Fork the repository on GitHub.
- Create a new branch with a descriptive name:
git checkout -b feature-name
- Make your changes and commit them:
git commit -m 'Add some feature'
- Push your changes to the branch:
git push origin feature-name
- Submit a pull request explaining the changes you have made.
This project is licensed under the [License Name] License - see the LICENSE.md file for details.
- Mention any contributors or libraries used in this project.