LibraLink is a library management system that I built mainly for library admins. It has features like user sign-in, managing books, book copies, premium members, employees, and tracking book checkouts. It also has a dashboard that shows cool graphs and stats about everything happening in the library.
The project aims to incorporate both basic and advanced functionalities over time, enhancing the overall library management experience.
Before you begin, ensure you have met the following requirements:
- Java JDK 11 or higher installed
- Maven or Gradle (specify the version)
- PostgreSQL (Database named "LibraLink" recommended)
- Download the latest version of Spring Tool Suite (STS)
To install and set up LibraLink, follow these steps:
-
Clone the Repository:
-
Database Setup:
- Set up a PostgreSQL database.
- Name the database "LibraLink" or choose another name (remember to update this in
application.properties
).
- Import Project into Spring Tool Suite:
- Open STS.
- Choose
File > Import > Existing Maven/Gradle Projects
and select the cloned directory.
- Configure Database:
- Navigate to
src/main/resources/
. - Open
application.properties
. - Update the database name, PostgreSQL username, and password.
- Run the Project:
- Right-click the project in STS and select
Run As > Spring Boot App
. - The project will run on port 8085.
- Access the Application:
- Open a web browser.
- Visit
https://localhost:8085/auth/login
.
- Account Management:
- To create an account, use the Signup option.
- To log in, use the Login option.
Once logged in, users can [describe basic functionalities available in your application, like browsing books, managing loans, etc.].
To contribute to LibraLink, follow these steps:
- Fork the repository.
- Create a branch:
git checkout -b <branch_name>
. - Make your changes and commit them:
git commit -m '<commit_message>'
- Push to the original branch:
git push origin <project_name>/<location>
- Create a pull request.
This project is licensed under the @2023 Umar Mohammad
If you have any questions or want to contribute, please email us at mohammadumar7w4@gmail.com