Переглянути джерело

Update README.md

Signed-off-by: Andrew Wallo <andrewdwallo@gmail.com>
3.x
Andrew Wallo 2 роки тому
джерело
коміт
09915d2000
Аккаунт користувача з таким Email не знайдено
1 змінених файлів з 64 додано та 45 видалено
  1. 64
    45
      README.md

+ 64
- 45
README.md Переглянути файл

@@ -1,66 +1,85 @@
1
-<p align="center"><a href="https://laravel.com" target="_blank"><img src="https://raw.githubusercontent.com/laravel/art/master/logo-lockup/5%20SVG/2%20CMYK/1%20Full%20Color/laravel-logolockup-cmyk-red.svg" width="400" alt="Laravel Logo"></a></p>
1
+# ERPSAAS
2 2
 
3
-<p align="center">
4
-<a href="https://github.com/laravel/framework/actions"><img src="https://github.com/laravel/framework/workflows/tests/badge.svg" alt="Build Status"></a>
5
-<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/dt/laravel/framework" alt="Total Downloads"></a>
6
-<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/v/laravel/framework" alt="Latest Stable Version"></a>
7
-<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/l/laravel/framework" alt="License"></a>
8
-</p>
3
+![Screenshot 2023-08-12 at 4 26 28 PM](https://github.com/andrewdwallo/erpsaas/assets/104294090/53538a06-38d1-41e6-888f-31960b0ffd8c)
9 4
 
10
-## About Laravel
5
+This repo is currently a work in progress — PRs and issues welcome!
11 6
 
12
-Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experience to be truly fulfilling. Laravel takes the pain out of development by easing common tasks used in many web projects, such as:
7
+# Getting started
13 8
 
14
-- [Simple, fast routing engine](https://laravel.com/docs/routing).
15
-- [Powerful dependency injection container](https://laravel.com/docs/container).
16
-- Multiple back-ends for [session](https://laravel.com/docs/session) and [cache](https://laravel.com/docs/cache) storage.
17
-- Expressive, intuitive [database ORM](https://laravel.com/docs/eloquent).
18
-- Database agnostic [schema migrations](https://laravel.com/docs/migrations).
19
-- [Robust background job processing](https://laravel.com/docs/queues).
20
-- [Real-time event broadcasting](https://laravel.com/docs/broadcasting).
9
+## Installation
21 10
 
22
-Laravel is accessible, powerful, and provides tools required for large, robust applications.
11
+Please check the official laravel installation guide for server requirements before you start. [Official Documentation](https://laravel.com/docs/10.x)
23 12
 
24
-## Learning Laravel
13
+Clone the repository
25 14
 
26
-Laravel has the most extensive and thorough [documentation](https://laravel.com/docs) and video tutorial library of all modern web application frameworks, making it a breeze to get started with the framework.
15
+    git clone https://github.com/andrewdwallo/erpsaas.git
27 16
 
28
-You may also try the [Laravel Bootcamp](https://bootcamp.laravel.com), where you will be guided through building a modern Laravel application from scratch.
17
+Switch to the repo folder
29 18
 
30
-If you don't feel like reading, [Laracasts](https://laracasts.com) can help. Laracasts contains over 2000 video tutorials on a range of topics including Laravel, modern PHP, unit testing, and JavaScript. Boost your skills by digging into our comprehensive video library.
19
+    cd erpsaas
31 20
 
32
-## Laravel Sponsors
21
+Install all the dependencies using composer and npm
33 22
 
34
-We would like to extend our thanks to the following sponsors for funding Laravel development. If you are interested in becoming a sponsor, please visit the Laravel [Patreon page](https://patreon.com/taylorotwell).
23
+    composer install
24
+    npm install
35 25
 
36
-### Premium Partners
26
+Copy the example env file and make the required configuration changes in the .env file
37 27
 
38
-- **[Vehikl](https://vehikl.com/)**
39
-- **[Tighten Co.](https://tighten.co)**
40
-- **[Kirschbaum Development Group](https://kirschbaumdevelopment.com)**
41
-- **[64 Robots](https://64robots.com)**
42
-- **[Cubet Techno Labs](https://cubettech.com)**
43
-- **[Cyber-Duck](https://cyber-duck.co.uk)**
44
-- **[Many](https://www.many.co.uk)**
45
-- **[Webdock, Fast VPS Hosting](https://www.webdock.io/en)**
46
-- **[DevSquad](https://devsquad.com)**
47
-- **[Curotec](https://www.curotec.com/services/technologies/laravel/)**
48
-- **[OP.GG](https://op.gg)**
49
-- **[WebReinvent](https://webreinvent.com/?utm_source=laravel&utm_medium=github&utm_campaign=patreon-sponsors)**
50
-- **[Lendio](https://lendio.com)**
28
+    cp .env.example .env
51 29
 
52
-## Contributing
30
+Generate a new application key
53 31
 
54
-Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the [Laravel documentation](https://laravel.com/docs/contributions).
32
+    php artisan key:generate
55 33
 
56
-## Code of Conduct
34
+Run the database migrations (**Set the database connection in .env before migrating**)
57 35
 
58
-In order to ensure that the Laravel community is welcoming to all, please review and abide by the [Code of Conduct](https://laravel.com/docs/contributions#code-of-conduct).
36
+    php artisan migrate
59 37
 
60
-## Security Vulnerabilities
38
+Build your dependencies & start the local development server
61 39
 
62
-If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell via [taylor@laravel.com](mailto:taylor@laravel.com). All security vulnerabilities will be promptly addressed.
40
+    npm run build
41
+    npm run dev
63 42
 
64
-## License
43
+You can now access the server at http://localhost:8000
65 44
 
66
-The Laravel framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).
45
+**Command list**
46
+
47
+    git clone https://github.com/andrewdwallo/erpsaas.git
48
+    cd erpsaas
49
+    composer install
50
+    npm install
51
+    cp .env.example .env
52
+    php artisan key:generate
53
+    php artisan migrate
54
+    npm run build
55
+    npm run dev
56
+
57
+## Database seeding
58
+
59
+**You may populate the database to help you get started quickly**
60
+
61
+Open the DatabaseSeeder and set the property values as per your requirement
62
+
63
+    database/seeders/DatabaseSeeder.php
64
+
65
+Default login information:
66
+
67
+    email: admin@gmail.com
68
+    password: password
69
+
70
+Run the database seeder
71
+
72
+    php artisan db:seed
73
+
74
+***Note*** : It's recommended to have a clean database before seeding. You can refresh your migrations at any point to clean the database by running the following command
75
+
76
+    php artisan migrate:refresh
77
+
78
+## Dependencies
79
+
80
+- [filamentphp/filament](https://github.com/filamentphp/filament) - A collection of beautiful full-stack components
81
+- [andrewdwallo/filament-companies](https://github.com/andrewdwallo/filament-companies) - A complete authentication system kit based on companies built for Filament
82
+- [leandrocfe/filament-apex-charts](https://github.com/leandrocfe/filament-apex-charts) - Apex Charts integration for Filament
83
+- [squirephp/squire](https://github.com/squirephp/squire) - A library of static Eloquent models for common fixture data
84
+
85
+***Note*** : It is recommended to read the documentation for all dependencies to get yourself familiar with how the application works.

Завантаження…
Відмінити
Зберегти