aeshki / laraweeb Goto Github PK

1. Introduction
2. Prerequisites
3. Installation
4. Usage
5. Contributing
6. License

About LaraWeeb is an open-source project based on Laravel 11 and Vue3 technologies powered by ViteJs. It's a template that allows you to easily create a social network with an anime / video game / manga theme.

List the software and tools required to run the project:

• Composer (version 2.7.2 or higher)
• PHP (version 8.2.0 or higher)
• Node.js and NPM or PNPM
• MySQL or any other database supported by Laravel

Steps to install and set up your project locally:

1. Clone the repository:

   git clone https://github.com/aeshki/LaraWeeb.git
   cd LaraWeeb

2. Install PHP dependencies with Composer:

   composer install

3. Install JavaScript dependencies with NPM or PNPM:

   npm i

   or

   pnpm i

4. Create a copy of the .env file:

   copy .env.example .env

5. Generate an application key:

   php artisan key:generate

6. Configure your database in the .env file ( optional ):

   DB_CONNECTION=mysql
   DB_HOST=127.0.0.1
   DB_PORT=3306
   DB_DATABASE=your_database_name
   DB_USERNAME=your_database_user
   DB_PASSWORD=your_database_password
   

7. Run the migrations to create the tables in the database:

   php artisan migrate

8. (Optional) Run the seeders to add sample data:

   php artisan db:seed

How to use or start the project:

1. Start the Laravel development server:

   php artisan serve

2. Start the ViteJs development server:

   npm run dev

   or

   pnpm run dev

3. Access the application in your browser at:

   http://localhost:8000
   

4. Login with admin user ( optional ):

   E-mail: [email protected]
   Password: admin
   

If you want to contribute, here are some steps to get started:

1. Fork the project
2. Create a branch for your feature:

   git checkout -b new-feature

3. Commit your changes:

   git commit -m 'Add some feature'

4. Push to the branch:

   git push origin new-feature

5. Open a Pull Request

This project is licensed under the [Apache 2.0 ] - see the LICENSE file for details.