Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
IndianGhost authored May 10, 2018
1 parent bd8730a commit 300872a
Showing 1 changed file with 43 additions and 58 deletions.
101 changes: 43 additions & 58 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,58 +1,43 @@
<p align="center"><img src="https://laravel.com/assets/img/components/logo-laravel.svg"></p>

<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>

## About Laravel

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 attempts to take the pain out of development by easing common tasks used in the majority of web projects, such as:

- [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.

## Learning Laravel

Laravel has the most extensive and thorough [documentation](https://laravel.com/docs) and video tutorial library of any modern web application framework, making it a breeze to get started learning the framework.

If you're not in the mood to read, [Laracasts](https://laracasts.com) contains over 1100 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.

## Laravel Sponsors

We would like to extend our thanks to the following sponsors for helping fund on-going Laravel development. If you are interested in becoming a sponsor, please visit the Laravel [Patreon page](https://patreon.com/taylorotwell):

- **[Vehikl](https://vehikl.com/)**
- **[Tighten Co.](https://tighten.co)**
- **[British Software Development](https://www.britishsoftware.co)**
- [Fragrantica](https://www.fragrantica.com)
- [SOFTonSOFA](https://softonsofa.com/)
- [User10](https://user10.com)
- [Soumettre.fr](https://soumettre.fr/)
- [CodeBrisk](https://codebrisk.com)
- [1Forge](https://1forge.com)
- [TECPRESSO](https://tecpresso.co.jp/)
- [Pulse Storm](http://www.pulsestorm.net/)
- [Runtime Converter](http://runtimeconverter.com/)
- [WebL'Agence](https://weblagence.com/)

## Contributing

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

## Security Vulnerabilities

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.

## License

The Laravel framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).
# Welcome to Shortcut URL ![version1.0](https://img.shields.io/badge/version-1.0-green.svg) [![Packagist](https://img.shields.io/packagist/l/doctrine/orm.svg)](https://github.com/IndianGhost/shortcutUrl/blob/master/LICENSE)

You can use this project (mini website) to shortcut URL adresses, it's a classic project that helps beginners to discover a new framework (laravel in this case).

# Install
Download or clone the project on your localhost (or server) by :
## Git
```
git clone https://github.com/IndianGhost/shortcutUrl.git
```
## Laravel
create the file ".env" (You will not find it by default on the project), copy & paste the content of the file ".env.example" into ".env" and configure the parameters of the database, here's my example :
```
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=shortcut_url
DB_USERNAME=root
DB_PASSWORD=null
```
On command prompt generate the app key by :
```
php artisan key:generate
```
The last command is to migrate the database :
```
php artisan migrate
```
Now that you did the migration, everything's is alright. Don't you trust me?
Ok, let's run the server ;)
```
php artisan serve
```

# Inteded users
Generally anybody can use this project but I think it will be helpful for software students or beginner php developers (I hope so).

# Copyright and license
Copyright 2018 Achraf BELLAALI **Shortcut URL** is a free open-source project. The code is released under [The MIT LICENSE](https://github.com/IndianGhost/shortcutUrl/blob/master/LICENSE) you can do whatever you want with it !

# Support My development
If you found it helpful, you can support me to develop new projects By :
[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.me/achrafbellaali)

0 comments on commit 300872a

Please sign in to comment.