Skip to content

Commit 435efec

Browse files
authored
Create README.md
1 parent 0ffca38 commit 435efec

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

README.md

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
<div align="center">
2+
<img src="https://user-images.githubusercontent.com/7591484/170873489-6aa40fe3-9d5c-476b-9434-f12f0a896c85.png" width="20%">
3+
4+
<h1> Scrawler MVC </h1>
5+
6+
<a href="https://github.com/scrawler-labs/app/actions/workflows/main.yml"><img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/scrawler-labs/app/main.yml?style=flat-square">
7+
</a>
8+
[![Codecov](https://img.shields.io/codecov/c/gh/scrawler-labs/app?style=flat-square)](https://app.codecov.io/gh/scrawler-labs/app)
9+
[![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/quality/g/scrawler-labs/app?style=flat-square)](https://scrutinizer-ci.com/g/scrawler-labs/app/?branch=main)
10+
<a href="[https://github.com/scrawler-labs/app/actions/workflows/main.yml](https://github.com/scrawler-labs/app/actions/workflows/main.yml)"><img src="https://img.shields.io/badge/PHPStan-enabled-brightgreen.svg?style=flat-square" alt="PHPStan Enabled"></a>
11+
[![Packagist Version](https://img.shields.io/packagist/v/scrawler/app?style=flat-square)](https://packagist.org/packages/scrawler/app)
12+
[![Packagist License](https://img.shields.io/packagist/l/scrawler/app?style=flat-square)](https://packagist.org/packages/scrawler/app)
13+
14+
<br>
15+
16+
🔥Create simple but powerful web apps and APIs quickly, with minumum lines of code🔥<br>
17+
🇮🇳 Made in India 🇮🇳
18+
</div>
19+
20+
## 💻 Installation
21+
You can install Scrawler App via Composer. If you don't have composer installed , you can download composer from [here](https://getcomposer.org/download/)
22+
23+
or if you want to start with an mvc template
24+
```sh
25+
composer create-project scrawler/mvc <project-name>
26+
```
27+
28+
## ✨ Folder Structure
29+
- `assets`: your css and js assets live here
30+
- `config`: global configuration files, you can add your own configurations here
31+
- `storage`: app caches , file storage stays here
32+
- `tests`: pest tests for your app lives here
33+
- `src`
34+
- `Controllers`: auto routed controller classes live here
35+
- `views`: blade view files live here
36+
- `boot.php`: boots the framework and register the required services , do not modify
37+
- `app.php`: you can register your services and configuration here
38+
- `routes.php`: manual routes can be added here if required
39+

0 commit comments

Comments
 (0)