Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dannycahyo/contact-management
A Java Spring Boot RESTful API for efficient management of users, contacts, and addresses, complete with comprehensive API documentation for easy integration.
https://github.com/dannycahyo/contact-management
contacts-app java liquibase mysql restful-api spring-boot
Last synced: 1 day ago
JSON representation
A Java Spring Boot RESTful API for efficient management of users, contacts, and addresses, complete with comprehensive API documentation for easy integration.
- Host: GitHub
- URL: https://github.com/dannycahyo/contact-management
- Owner: dannycahyo
- Created: 2024-06-17T07:08:48.000Z (5 months ago)
- Default Branch: master
- Last Pushed: 2024-06-28T15:45:32.000Z (4 months ago)
- Last Synced: 2024-06-28T16:44:40.956Z (4 months ago)
- Topics: contacts-app, java, liquibase, mysql, restful-api, spring-boot
- Language: Java
- Homepage:
- Size: 82 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Contact Management
Contact Management is a Java Spring Boot RESTful API project designed for managing users, contacts, and addresses, facilitating comprehensive contact management functionalities within applications.
## API Documentation
For a detailed guide on how to use the Contact Management API, including endpoints for managing users, contacts, and addresses, please refer to our [API Documentation](https://documenter.getpostman.com/view/12539711/2sA3duEssJ). This comprehensive documentation is hosted on Postman and provides you with all the necessary information to integrate our API into your application seamlessly. It includes example requests, responses, and a clear explanation of each endpoint's functionality.
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
### Prerequisites
Before you begin, ensure you have met the following requirements:
- Java JDK 17 or newer
- Maven
- MySQL
### Installation
1. **Clone the repository**
```bash
git clone https://github.com/yourusername/contact-management.git
cd contact-management
```
2. **Configure MySQL Database**
Create a database in MySQL and note the credentials. You will need to update the environment variables accordingly.
3. **Set Environment Variables**
Set the following environment variables based on your MySQL configuration:
- `DB_USER`: Database username
- `DB_PASSWORD`: Database password
- `DB_HOST`: Database host (e.g., localhost)
- `DB_PORT`: Database port (default is 3306)
- `DB_NAME`: Database name
You can set these variables in your IDE or export them in your terminal session.
If you're [using VS Code](https://stackoverflow.com/questions/59687712/how-to-set-java-environment-variable-in-vs-code), you can set them in the `launch.json` file under the `.vscode` directory.
4. **Run the Application**
Depending on your IDE, you can run the application by running the main class `ContactManagementApplication`, or you can run the following command:
```bash
mvn spring-boot:run
```
Make sure to export the environment variables before running the application. The application will start on port 8080 by default.
## Contributing
Contributions are welcome! For major changes, please open an issue first to discuss what you would like to change.