Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mfrancoisbbs committed Jul 3, 2017
1 parent 73cc39f commit 3a45b25
Showing 1 changed file with 63 additions and 26 deletions.
89 changes: 63 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,77 @@
<p align="center"><img src="https://laravel.com/assets/img/components/logo-laravel.svg"></p>
#Default Laravel project with Expendable

<p align="center">
<a href="https://travis-ci.org/laravel/framework"><img src="https://travis-ci.org/laravel/framework.svg" alt="Build Status"></a>
<a href="https://packagist.org/packages/laravel/framework"><img src="https://poser.pugx.org/laravel/framework/d/total.svg" alt="Total Downloads"></a>
<a href="https://packagist.org/packages/laravel/framework"><img src="https://poser.pugx.org/laravel/framework/v/stable.svg" alt="Latest Stable Version"></a>
<a href="https://packagist.org/packages/laravel/framework"><img src="https://poser.pugx.org/laravel/framework/license.svg" alt="License"></a>
</p>
X.y.z is a fresh instance of laravel 5.* with Expendable package configured.
Check the require before install it.

## About Laravel

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:
##Table of contents
1. [Require](#require)
1. [Installation](#installation)
1. [Create project](#1-create-project)
1. [Environment and configuration](#2-environment-and-configuration)
1. [Database and translation configuration](#database-and-translation-configuration)
1. [Vhost](#vhost)

- [Simple, fast routing engine](https://laravel.com/docs/routing).
- [Powerful dependency injection container](https://laravel.com/docs/container).
- Multiple back-ends for [session](https://laravel.com/docs/session) and [cache](https://laravel.com/docs/cache) storage.
- Expressive, intuitive [database ORM](https://laravel.com/docs/eloquent).
- Database agnostic [schema migrations](https://laravel.com/docs/migrations).
- [Robust background job processing](https://laravel.com/docs/queues).
- [Real-time event broadcasting](https://laravel.com/docs/broadcasting).

Laravel is accessible, yet powerful, providing tools needed for large, robust applications. A superb combination of simplicity, elegance, and innovation give you tools you need to build any application with which you are tasked.

## Learning Laravel

Laravel has the most extensive and thorough documentation and video tutorial library of any modern web application framework. The [Laravel documentation](https://laravel.com/docs) is thorough, complete, and makes it a breeze to get started learning the framework.
##Require
To use this project you have to install:

If you're not in the mood to read, [Laracasts](https://laracasts.com) contains over 900 video tutorials on a range of topics including Laravel, modern PHP, unit testing, JavaScript, and more. Boost the skill level of yourself and your entire team by digging into our comprehensive video library.
1. Php 5.6 or more
3. Active mpcrypt
4. Composer (https://getcomposer.org/download/)[https://getcomposer.org/download/]
5. Sass (`gem install sass`)
6. NodeJs version 3.0.0
7. npm run dev

## Contributing

Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the [Laravel documentation](http://laravel.com/docs/contributions).

## Security Vulnerabilities
##Installation

If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell at [email protected]. All security vulnerabilities will be promptly addressed.

## License
###1.Create project
When you want create a new empty project with composer use this command:

```ssh
composer create-project distilleries/xyz
```

If you doesn't want use composer just checkout the project and run composer install:

```ssh
git clone https://github.com/Distilleries/Xyz.git
composer install
```

###2.Environment and configuration

#### Database and translation configuration

1. Edit `.env` file and put the name of your environment (local,production,staging...).
1. Edit `.env` add your database ocnfiguration.


Create your database and after run the update composer:

```
composer update
```


####Vhost

Configuration your virtual host with `/public` folder in site root.


If everything was done without error you can access to the url `/admin`.
If you want to connect a the back end just run the seed command.

```
php artisan db:seed
```

After that take one user email address from the table `users` and use the password `test`.

The Laravel framework is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT).

0 comments on commit 3a45b25

Please sign in to comment.