Larakit

A Laravel 11.x Sales Dashboard Starter Kit
View Demo

Table of Contents

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

About The Project

A lightweight and customizable Sales Dashboard starter kit built with Laravel Breeze, Inertia.js, and React. This kit provides the essential tools and UI components needed to quickly set up a modern sales management system.

Features:

• Authentication & Authorization (Laravel Breeze)
• User & Role Management
• Organization Management
• Sales Tracking & Analytics
• Dashboard with Charts & Reports
• Dark Mode & Responsive UI
• OAuth with Laravel Socialite

Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

Getting Started

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

Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

1. Clone the repo

git clone git@github.com:iamdipankarj/larakit.git

2. Install NPM packages

yarn install

3. Start Vite Server

yarn dev

4. Start PHP Server

php artisan serve

5. Start PHP Server on Local Network

• Get your LAN ip by running ifconfig (Mac/Linux) or ipconfig (Windows)
• Make sure to change APP_URL, SALES_API_BASE and APP_URL to your LAN ip, e.g http://192.168.0.57:8000.
• Google OAuth login may not work on local area network due to restrictions on the OAuth policies of google. As a work around, you'd need to create a local only domain like larakit.test to be able to add it on google oauth client credentials.

php artisan serve --host=0.0.0.0 --port=8000

yarn dev --host 192.168.0.57 --port 5174

Configuring Database

• Make sure postgresql is installed in your system.
• You can use Homebrew if you are on a mac.
• After installing, run brew services start postgresql to start the service.
• Once you're in the psql shell. Run the following.

Drop any existing ones with the same name.

DROP DATABASE IF EXISTS larakit;

Drop role if exists, if you know your psql role, you can use that one.

DROP ROLE IF EXISTS <YOUR_USERNAME>;

Create a role with password.

CREATE ROLE <YOUR_USERNAME> WITH LOGIN PASSWORD 'admin';

Create the database and link it to the role you just created.

CREATE DATABASE larakit OWNER <YOUR_USERNAME>;

Once created, make sure to configure it on the laravel .env file. Once done, run the following to migrate the database and populate it with some seed data required for the application to work.

php artisan migrate
php artisan db:seed

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 fork 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

License

Distributed under the Unlicense License. See LICENSE.txt for more information.

Contact

Dipankar Jana - @iamdipankarj - iamdipankarj@gmail.com

Project Link: https://github.com/iamdipankarj/larakit

(back to top)