Giter VIP home page Giter VIP logo

cloud-book-writer's Introduction

Book Store Cloud

About App


Book Store Cloud is a web application built with Laravel PHP. A dynamic platform catering to two distinct user types: Authors and Collaborators. Authors are empowered to manage and showcase their literary works, while Collaborators can explore an extensive collection of books across genres. Both user types must register to unlock the platform's full potential, ensuring a secure and welcoming environment. We're dedicated to fostering a vibrant literary community, connecting authors with their readers, and celebrating the power of storytelling. Join us on this literary journey where words come to life, and stories find their readers.

Features


  • User Registration and Profiles: Create personalized profiles, providing information about themselves, their literary works, and reading preferences.
  • Book Management for Authors: Can easily add, edit, and manage their books.
  • Search and Browse: can search for books by genre, author, title, or keywords.
  • Author-Reader Interaction: Authors can engage with their readers through comments, messages.
  • Mobile Accessibility: Can access anywhere and anytime.

Installation


Prerequisites

  • PHP (>= 8.1)
  • Laravel(>= 7.x)
  • Composer (>= 2.6)
  • npm (>= 9.0)
  • Laravel Sanctum (>= 3.0)
  • darkaonline/l5-swagger (>= 8.0)
  • swagger-ui (>= 5.0)

Clone the repository

git clone https://github.com/hdr105/cloud-book-writer

Navigate to the project directory

cd cloud-book-writer

- Composer

Install dependencies:

composer install

- NPM

npm install 
npm run dev

- Laravel Sanctum

Its time to install laravel sanctum: You may install Laravel Sanctum via the Composer package manager:

composer require laravel/sanctum

Next, you should publish the Sanctum configuration

php artisan vendor:publish --provider="Laravel\Sanctum\SanctumServiceProvider"

Finally, you should run your database migrations.

php artisan migrate

You can get detail laravel sanctum documentation here.

- L5 Swagger

Lets install darkonline/l5swagger:

composer require "darkaonline/l5-swagger"

Open your AppServiceProvider (located in app/Providers) and add this line in register function

$this->app->register(\L5Swagger\L5SwaggerServiceProvider::class);

or open your config/app.php and add this line in providers section

L5Swagger\L5SwaggerServiceProvider::class,

You can publish L5-Swagger's config:

$ php artisan vendor:publish --provider "L5Swagger\L5SwaggerServiceProvider"

Files can be viewed into your project by running:

$ php artisan l5-swagger:generate

You can get detail darkaonline/l5-swagger documentation here.

- DB Seeding

To generate a seeder, execute the make:seeder Artisan command. All seeders generated by the framework will be placed in the database/seeders directory:

$ php artisan make:seeder UserSeeder

Environment Configuration


Configure environment variables:

In .env file, Update the file with your own database credentials and other necessary configurations. Generate application key:

php artisan key:generate

Run migrations:

php artisan migrate

Start the local development server:

php artisan serve

Usage Create a new project and add tasks to it. Drag and drop tasks to change their priority. Edit or delete tasks as needed. Deployment Follow these steps to deploy the application on a server:

Create a new database on your server and update the '.env file with the database credentials. Copy the project files to your server. Set proper file permissions to the required directories.

Configure any necessary server-specific settings (e.g., environment variables, virtual hosts). Access the application through your server's domain or IP address.

Contributions are welcome! Feel free to fork the repository and submit pull requests.

License


This project is licensed under the MIT License. See the LICENSE file for more information.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.