|
1 | | -<p align="center"> |
2 | | - <br><br> |
3 | | - <img src="https://leaf-docs.netlify.com/images/logo.png" height="100"/> |
4 | | - <h1 align="center">Leaf MVC</h1> |
5 | | - <br> |
6 | | - <br><br><br> |
7 | | -</p> |
| 1 | +# README |
8 | 2 |
|
| 3 | +This README would normally document whatever steps are necessary to get the |
| 4 | +application up and running. |
9 | 5 |
|
10 | | -[](https://packagist.org/packages/leafs/mvc) |
11 | | -[](https://packagist.org/packages/leafs/mvc) |
12 | | -[](https://packagist.org/packages/leafs/mvc) |
| 6 | +Things you may want to cover: |
13 | 7 |
|
| 8 | +* PHP version |
14 | 9 |
|
15 | | -# Leaf |
16 | | -LeafMVC is a simple MVC framework built on top of the leaf php micro-framework. LeafMVC lets you create clean but powerful web apps and APIs quickly. Leaf provides simple to use functions to take care of complex issues, eventually speeding up development and taking the pain out of development. |
| 10 | +* System dependencies |
17 | 11 |
|
18 | | -## Installation |
| 12 | +* Configuration |
19 | 13 |
|
20 | | -It's recommended that you use [Composer](https://getcomposer.org/) to install Leaf. |
| 14 | +* Database creation |
21 | 15 |
|
22 | | -```bash |
23 | | -$ composer create project leafs/mvc <project-name> |
24 | | -``` |
| 16 | +* Database initialization |
25 | 17 |
|
26 | | -This will start a new LeafMVC app. |
| 18 | +* How to run the test suite |
27 | 19 |
|
| 20 | +* Services (job queues, cache servers, search engines, etc.) |
28 | 21 |
|
29 | | -## Basic Info |
30 | | -```bash |
31 | | -C:. |
32 | | -├───app |
33 | | -│ ├───console |
34 | | -│ ├───controllers |
35 | | -│ │ └───Auth |
36 | | -│ ├───database |
37 | | -│ │ ├───factories |
38 | | -│ │ ├───migrations |
39 | | -│ │ └───seeds |
40 | | -│ ├───helpers |
41 | | -│ ├───models |
42 | | -│ ├───routes |
43 | | -│ └───views |
44 | | -│ ├───assets |
45 | | -│ │ ├───css |
46 | | -│ │ ├───images |
47 | | -│ │ ├───js |
48 | | -│ │ └───sass |
49 | | -│ ├───components |
50 | | -│ └───pages |
51 | | -│ └───errors |
52 | | -├───config |
53 | | -│ └───command |
54 | | -├───public |
55 | | -├───storage |
56 | | -│ ├───app |
57 | | -│ │ └───public |
58 | | -│ ├───framework |
59 | | -│ │ └───views |
60 | | -│ └───logs |
61 | | -└───vendor |
62 | | -``` |
63 | | -This directory structure is a blend of Ruby on Rails and Laravel |
| 22 | +* Deployment instructions |
64 | 23 |
|
65 | | -To run your LeafMVC application, use |
66 | | -```bash |
67 | | -php leaf serve |
68 | | -``` |
69 | | - |
70 | | -## Learning LeafMVC |
71 | | - |
72 | | -LeafMVC has a very easy to understand [documentation](https://leafmvc.netlify.com/) which contains information on all operations in LeafMVC. |
73 | | - |
74 | | -Since LeafMVC runs on Leaf, you can check out the Leaf PHP Framework documentation [here](https://leaf-docs.netlify.com). |
75 | | - |
76 | | - |
77 | | -## License |
78 | | - |
79 | | -The LeafMVC framework is open-source software licensed under the [MIT license](https://opensource.org/licenses/MIT). |
80 | | - |
81 | | - |
82 | | -## View LeafMVC's docs [here](https://leafmvc.netlify.com/) |
83 | | -## View Leaf's docs [here](https://leaf-docs.netlify.com/) |
| 24 | +* ... |
0 commit comments