Skip to content

Latest commit

 

History

History
99 lines (65 loc) · 2.34 KB

README.md

File metadata and controls

99 lines (65 loc) · 2.34 KB

Cloud Book Writer

Cloud Book Writer is a skeleton application for the Laravel framework. This application helps authors manage and structure their book content seamlessly.

Requirements

  • PHP ^8.1
  • Composer
  • Laravel ^10.10

Installation

  1. Clone the Repository:
git clone https://github.com/gacbaluyot/cloud-book-writer.git
  1. Change directory to the project's root folder:
cd cloud-book-writer
  1. Install Dependencies:
composer install
  1. Environment Setup:
  • Copy .env.example to .env:
cp .env.example .env
  • Update .env with your database and other configuration details.
  1. Generate Application Key:
php artisan key:generate
  1. Run Migrations and Seeders:
php artisan migrate --seed
  1. Start the Development Server:

Now, navigate to the displayed URL (usually http://localhost:8000) in your browser.

Frontend Setup

This project uses Vite for a better front-end development experience. Here's how to set it up:

  1. Install Node Dependencies:
npm install
  1. Development:
  • To start the development server: 
    npm run dev
  1. Production:
  • To build for production: 
    npm run build

Frontend Packages

  • Vite: A build tool that aims to provide a faster and leaner development experience for modern web projects. More about Vite.
  • Bootstrap: The world’s most popular front-end open-source toolkit. More about Bootstrap.
  • axios: A promise-based HTTP client for the browser and Node.js. More about axios.
  • @popperjs/core: Popper is a positioning engine; its purpose is to calculate the position of an element to make it possible to position it near a given reference element. More about Popper.js.
  • sass: Sass is the most mature, stable, and powerful professional grade CSS extension language in the world. More about Sass.

Features

  • Book Management: Add, edit, and organize book content.
  • Collaborator Assignment: Assign roles to collaborators.
  • Section Management: Structure your book's content in sections.

Contributing

Contributions, issues, and feature requests are welcome! Please ensure to follow the standard pull request process and ensure tests pass.