https://github.com/alibori/book-exchange-api

Book exchange API project
https://github.com/alibori/book-exchange-api

api filamentphp laravel

Last synced: about 1 month ago
JSON representation

Book exchange API project

• Host: GitHub
• URL: https://github.com/alibori/book-exchange-api
• Owner: alibori
• Created: 2024-01-23T14:30:56.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-03-24T17:36:47.000Z (9 months ago)
• Last Synced: 2024-03-24T19:39:32.676Z (9 months ago)
• Topics: api, filamentphp, laravel
• Language: PHP
• Homepage:
• Size: 1.16 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Book Exchange API

API for a Book Exchanging community. This project is still under development.

## Installation

1. Clone the repository.

2. Run `composer install` to install the dependencies.

3. Create a `.env` file by copying the `.env.example` file and updating the database and mailing credentials.

4. Run `nvm use` to use the correct Node.js version.

5. Run `npm install` to install the dependencies.

6. Run `npm run dev` to compile the assets.

7. Run `php artisan key:generate` to generate the application key.

8. Run `php artisan storage:link` to create a symbolic link to the storage directory.

9. Run `php artisan migrate` to run the migrations.

10. Run `php artisan db:seed` to seed the database with the default data.

11. Run `php artisan serve` to start the server.

12. In another terminal, run `php artisan queue:listen` to start the queue listener.

## Features

- User registration.

- User profile management.

- Admin dashboard.

- Book library management.

- Book loans requests.

- Email notifications.

## Admin Dashboard

Visit `/admin` to access the admin dashboard. The default credentials are:

- Email: `[email protected]`

- Password: `12345678`

## API Documentation

The API documentation is available at `/docs/api`.