Skip to content
This repository was archived by the owner on Mar 13, 2023. It is now read-only.

Commit 1588f51

Browse files
committed
Add readme to project
1 parent 09c2d01 commit 1588f51

File tree

1 file changed

+90
-0
lines changed

1 file changed

+90
-0
lines changed

readme.md

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
<p align="center"><img src="https://laravelcm.com/img/logo-laravelcm.svg"></p>
2+
3+
## Laravel PHP Framework
4+
5+
[![Build Status](https://travis-ci.org/laravel/framework.svg)](https://travis-ci.org/laravel/framework)
6+
[![Total Downloads](https://poser.pugx.org/laravel/framework/d/total.svg)](https://packagist.org/packages/laravel/framework)
7+
[![Latest Stable Version](https://poser.pugx.org/laravel/framework/v/stable.svg)](https://packagist.org/packages/laravel/framework)
8+
[![Latest Unstable Version](https://poser.pugx.org/laravel/framework/v/unstable.svg)](https://packagist.org/packages/laravel/framework)
9+
[![License](https://poser.pugx.org/laravel/framework/license.svg)](https://packagist.org/packages/laravel/framework)
10+
11+
12+
Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable, creative experience to be truly fulfilling. Laravel attempts to take the pain out of development by easing common tasks used in the majority of web projects, such as authentication, routing, sessions, queueing, and caching.
13+
14+
Laravel is accessible, yet powerful, providing powerful tools needed for large, robust applications. A superb inversion of control container, expressive migration system, and tightly integrated unit testing support give you the tools you need to build any application with which you are tasked.
15+
16+
## Official Documentation
17+
18+
Documentation for the framework can be found on the [Laravel website](http://laravel.com/docs).
19+
20+
## System Requirement
21+
22+
* Web Server as:
23+
- Apache 2.4.x or higher with rewrite engine on (mod_rewrite)
24+
- Nginx 1.11.x or higher
25+
* Database that laravel supports, actually can be:
26+
- MySQL 5.7 (For index length size)
27+
* Composer
28+
* Git
29+
* NodeJS 6.x or higher
30+
* PHP 7.1.x or higher and the extensions:
31+
- Mcrypt
32+
- OpenSSL
33+
- Mbstring
34+
- Tokenizer
35+
- FileInfo
36+
* Set up the required ENV variables, the more you set up the better though
37+
- `DB_CONNECTION`
38+
- `DB_HOST`
39+
- `DB_PORT`
40+
- `DB_USERNAME`
41+
- `DB_PASSWORD`
42+
43+
## Installation and Configuration
44+
* Fork the repository & clone it to your host machine
45+
46+
```shell
47+
$ git clone https://github.com/laravelcm/website.git my-community
48+
```
49+
50+
* Change to the root of your application's directory and install dependencies
51+
52+
```shell
53+
$ cd my-community
54+
$ composer install
55+
```
56+
57+
* Make a copy of the `.env.example` file and name it `.env`
58+
59+
```shell
60+
$ cp .env.example .env
61+
```
62+
63+
* Generate a new application key using `artisan`
64+
65+
```shell
66+
$ php artisan key:generate
67+
```
68+
69+
* Set up your database and enter the credentials in the `.env` file
70+
71+
```
72+
DB_CONNECTION=
73+
DB_HOST=
74+
DB_PORT=
75+
DB_DATABASE=
76+
DB_USERNAME=
77+
DB_PASSWORD=
78+
```
79+
80+
## Contributing
81+
82+
Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the [Laravel documentation](http://laravel.com/docs/contributions).
83+
84+
## Security Vulnerabilities
85+
86+
If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell at taylor@laravel.com. All security vulnerabilities will be promptly addressed.
87+
88+
### License
89+
90+
The Laravel framework is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT)

0 commit comments

Comments
 (0)