ojpro / my-library

My Local Library for Developers

Developer Library

Library with all functionality to save, organize and access any resources.

Features - (MVP #1)

• CRUD operations
• Live Search
• Single Page Application
• Light/dark themes

Requirement

consider installing does packages before start installing the project

• php-imagick : used to generate books' thumbnails
• php-sqlite3 : used for testing

Run Locally

Clone the project

  git clone https://github.com/ojpro/my-library.git

Go to the project directory

  cd my-library

Install dependencies

  composer install
  npm install

Configure database connection

  cp .env.example .env
  # Edit .env file on any text editor and
  # set connection variables
  vi .env

Migrate database

  php artisan migrate

Start the server

  npm run dev

🎉 I hope you like the first version (Simplest one).

Running Tests

To run tests, run the following command

  php artisan test

Screenshots - (Preview)

Roadmap

• Set Book Thumbnail
• Create Categories
• Add Authors
• Rating

Long-Term Features

• More media support

• Store Code Snippets

• Annotation

License

MIT