Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thetechguy44/library-management-system-api
A RESTful API for a Library Management System built with Laravel 11 and full documentation.
https://github.com/thetechguy44/library-management-system-api
api laravel-framework library library-management-system management-system restful-api
Last synced: about 2 months ago
JSON representation
A RESTful API for a Library Management System built with Laravel 11 and full documentation.
- Host: GitHub
- URL: https://github.com/thetechguy44/library-management-system-api
- Owner: Thetechguy44
- Created: 2024-09-08T06:30:53.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-09-25T00:19:58.000Z (3 months ago)
- Last Synced: 2024-10-18T13:25:46.347Z (3 months ago)
- Topics: api, laravel-framework, library, library-management-system, management-system, restful-api
- Language: PHP
- Homepage:
- Size: 131 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Library Management System API
This is a RESTful API for a Library Management System built with Laravel 11.
## Features
- CRUD operations for Books, Authors, and Users
- Book borrowing and returning functionality
- Role-based access control (Admin, Librarian, Member)
- Search functionality for books
- Advanced search functionality (e.g., search by author or title)
- API documentation with Swagger/OpenAPI
- Caching for improved performance
- Book reviews and ratings.
- Book reservations.
- Fine management.
## Requirements
- PHP 8.2+
- Composer
## Setup Instructions
1. Clone the repository:
```
git clone https://github.com/thetechguy44/library-management-system-api.git
cd library-management-system-api
```
2. Install dependencies:
```
composer install
```
3. Copy the `.env.example` file to `.env` and configure your environment variables:
```
cp .env.example .env
```
4. Generate an application key:
```
php artisan key:generate
```
5. Run database migrations:
```
php artisan migrate
```
6. (Optional) Seed the database with sample data:
```
php artisan db:seed
```
7. Start the development server:
```
php artisan serve
```
## API Documentation
After setting up the project, you can access the API documentation at:
```
http://localhost:8000/api/documentation
```
## Running Tests
To run the feature tests:
```
php artisan test
```
## License
This project is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).