Skip to content

Commit

Permalink
Merge pull request ajaynegi45#71 from neeru24/patch-1
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
Devamani11D authored Oct 13, 2024
2 parents c510f81 + 8f3a311 commit 186da19
Showing 1 changed file with 25 additions and 16 deletions.
41 changes: 25 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,11 @@

LibraryMan is a user-friendly software solution for schools, companies, and libraries to efficiently manage book collections, track borrowing, and monitor due dates. It streamlines operations, reduces errors, and enhances the lending experience, making it easy to maintain a well-organized library.

Checkout [Frontend](https://github.com/ajaynegi45/LibraryMan) Repository
#### Checkout [Frontend](https://github.com/ajaynegi45/LibraryMan) Repository

<br>

## Project Structure 📂
## Project Structure 📂
Checkout [Project Structure](https://github.com/ajaynegi45/LibraryMan-API/tree/main/project-structure) Diagram

<br>

## API Endpoints 🔗

#### Learn More
Expand All @@ -19,8 +15,6 @@ Want to know more about our API endpoints? Check out our [API Documentation](htt
#### Test Endpoints
Ready to try out our API endpoints? Use [Postman Documentation](https://documenter.getpostman.com/view/28691426/2sAXjJ6D7L) to test and explore our APIs.

<br>

## How to Run the Project 💨

1. Ensure you have Java and MySQL installed on your system.
Expand All @@ -29,19 +23,13 @@ Ready to try out our API endpoints? Use [Postman Documentation](https://document
4. Set up the MySQL database and update the database configurations in the `application-development.properties` file.
5. Build and run the project using the IDE or by running `mvn spring-boot:run` command from the project root directory.

<br>

## ‼️ Important Note ‼️

- You need to set up the database and make sure the application properties are correctly configured to run the project successfully.

<br>

## Upcoming Update
Adding more features, error handling, authentication, and security measures.

<br>

## Contributing 🤗

Feel free to explore and use these project. If you encounter any issues or have suggestions for improvements, please feel free to contribute or reach out for assistance.
Expand All @@ -52,8 +40,6 @@ See [`contributing.md`](https://github.com/ajaynegi45/Library-API/blob/main/Cont

Please adhere to this project's [`code_of_conduct.md`](https://github.com/ajaynegi45/Library-API/blob/main/code_of_conduct.md).

<br>

## Contact Information 📧

If you have any questions or would like to connect, please don't hesitate to reach out. I'd be more than happy to chat and learn from your experiences too.
Expand All @@ -64,6 +50,29 @@ If you have any questions or would like to connect, please don't hesitate to rea
## Contributors
<img src="https://contrib.rocks/image?repo=ajaynegi45/LibraryMan-API" />

---

<table>
<thead align="center">
<tr border: 2px;>
<td><b>🌟 Stars</b></td>
<td><b>🍴 Forks</b></td>
<td><b>🐛 Issues</b></td>
<td><b>🔔 Open PRs</b></td>
<td><b>🔕 Close PRs</b></td>
</tr>
</thead>
<tbody>
<tr>
<td><img alt="Stars" src="https://img.shields.io/github/stars/ajaynegi45/LibraryMan-API?style=flat&logo=github"/></td>
<td><img alt="Forks" src="https://img.shields.io/github/forks/ajaynegi45/LibraryMan-API?style=flat&logo=github"/></td>
<td><img alt="Issues" src="https://img.shields.io/github/issues/ajaynegi45/LibraryMan-API?style=flat&logo=github"/></td>
<td><img alt="Open Pull Requests" src="https://img.shields.io/github/issues-pr/ajaynegi45/LibraryMan-API?style=flat&logo=github"/></td>
<td><img alt="Close Pull Requests" src="https://img.shields.io/github/issues-pr-closed/ajaynegi45/LibraryMan-API?style=flat&color=green&logo=github"/></td>
</tr>
</tbody>
</table>


### Stargazers

Expand Down

0 comments on commit 186da19

Please sign in to comment.