Laravel 9 - OFTC Base Template

An awesome laravel starter template to jumpstart your project!

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
   • Used Packages
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact
7. Maintainers
8. Acknowledgments

1. About The Project

Laravel 9 - One For The Code Base is a laravel 9 basic install with extra components, tools, traits, livewire components and many other developer or production extra's

(back to top)

Built With

(back to top)

Used Packages

To see all the details of the used and installed composer/npm packages and their documentation please read the PACKAGES.md file for more information.

(back to top)

2. Getting Started

This is an example of how you may be setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

The following tools and services need to be installed on your development or production enviroment. If these tools or services aren't installed yet, please follow the install guides of the tools or services itself.

Required

• git download
• nodejs 14.17+ download
• php 8.x download
• composer 2.2+ download

Optional

• HTTP server with PHP support (e.g.: Apache, Nginx, Caddy)
• A supported database (e.g.: MySQL, MariaDB, PostgreSQL, Redis)

Installation

1. Clone the repo

   git clone https://github.com/OneForTheCode/Laravel-9-OFTC-Base.git

2. Change to the working directory

   cd Laravel-9-OFTC-Base

3. Install Composer packages (development)

   composer install -o

   Install Composer packages (production)

   composer install --no-dev -o

4. Install NPM packages

   npm install

5. Copy the example enviroment variables

   cp .env.example .env

6. Generate the application key in .env

   php artisan key:generate

   ⚠️ Warning:

   Never change the APP_KEY after installation on production enviroment. This wil result in all of your encrypted/hashed data being lost!

7. Running database migrations

   php artisan migrate

8. Build and run npm dependencies

   npm run dev

(back to top)

3. Usage

After the installation you may configure your webserver to serve the public folder or launch the localhost server (example below) and visit the page on localhost:8000.

php artisan serve

(back to top)

4. Contributing

Contributions are what make the open source community such an amazing place to learn, inspire and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please for the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature)
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

5. License

Distributed under the MIT License. see LICENSE for more information.

(back to top)

6. Contact

• One For The Code - info@oftc.be
• All In One - @allinonebe - info@all-in-one.be
• Project Link: https://github.com/OneForTheCode/Laravel-9-OFTC-Base

(back to top)

7. Maintainers

• Dennnis de Houx - dennis@aio.be

(back to top)

8. Acknowledgments

• Spatie
• barryvdh
• saadeghi
• ascsoftw
• jantinnerezo
• Power-Components
• asantibanez)
• mediconesystems

(back to top)