Permalink
Browse files

added readme.md and cleaner env.example for publishing

  • Loading branch information...
wi-wissen committed Jun 25, 2017
1 parent 66990bb commit 54d60751689c41ca3cbf04fab0e6e3eff3426b14
Showing with 65 additions and 23 deletions.
  1. +7 −7 .env.example
  2. +58 −16 readme.md
@@ -3,19 +3,19 @@ APP_DEBUG=true
APP_KEY=SomeRandomString

DB_HOST=localhost
DB_DATABASE=homestead
DB_USERNAME=homestead
DB_PORT=3306
DB_DATABASE=friendzone
DB_USERNAME=friendzone
DB_PASSWORD=secret

CACHE_DRIVER=file
SESSION_DRIVER=file
QUEUE_DRIVER=sync

MAIL_DRIVER=smtp
MAIL_HOST=mailtrap.io
MAIL_PORT=2525
MAIL_USERNAME=null
MAIL_PASSWORD=null
MAIL_ENCRYPTION=null
MAIL_HOST=localhost
MAIL_PORT=587
MAIL_USERNAME=no-replay@friendzone.app
MAIL_PASSWORD=secret

PHPMYADMIN=phpmyadmin.app
@@ -1,27 +1,69 @@
## Laravel PHP Framework
##friendzone - a social network is rising

[![Build Status](https://travis-ci.org/laravel/framework.svg)](https://travis-ci.org/laravel/framework)
[![Total Downloads](https://poser.pugx.org/laravel/framework/d/total.svg)](https://packagist.org/packages/laravel/framework)
[![Latest Stable Version](https://poser.pugx.org/laravel/framework/v/stable.svg)](https://packagist.org/packages/laravel/framework)
[![Latest Unstable Version](https://poser.pugx.org/laravel/framework/v/unstable.svg)](https://packagist.org/packages/laravel/framework)
[![License](https://poser.pugx.org/laravel/framework/license.svg)](https://packagist.org/packages/laravel/framework)
**Source code and install instructions are in English. Documentation and excersices currently are available in German only.**

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.
friendzone is a social network for educational purpose only. Students can create their own social network as a database admin. They learn basics about working in a software project, creating and managing a database, querying (SQL SELECT) and editing (SQL INSERT, UPDATE and DELETE).
This project aims to help students develop a general technical understanding of social networks. As result, they will be able to discuss sinjects as big data and information privacy.

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.
Live Demo: https://friendzone.wi-wissen.de/
Read more (only in German): https://blog.wi-wissen.de/tag/friendzone

## Official Documentation
###Standing on the shoulders of giants

Documentation for the framework can be found on the [Laravel website](http://laravel.com/docs).
Many thanks and respect to:

## Contributing
- [MySQL](https://www.mysql.com/)
- [php](http://php.net/)
- [Laravel](https://laravel.com/)
- [laracasts/flash](https://github.com/laracasts/flash)
- [rap2hpoutre/laravel-log-viewer](https://github.com/rap2hpoutre/laravel-log-viewer)
- [barryvdh/laravel-debugbar](https://github.com/barryvdh/laravel-debugbar)
- [gbrock/laravel-table ](https://github.com/gbrock/laravel-table)
- [Bootstrap](http://bootstrap.com/)
- [jQuery](https://jquery.com/) with [Backstretch](https://github.com/jquery-backstretch/jquery-backstretch)
- Kitten image by [Nicolas Suzor](https://www.flickr.com/photos/nicsuzor/) (CC BY-NC-SA)
- Splash images by [unsplash.com](https://unsplash.com/) (CCO)
- Face images by [Greg Peverill-Conti](https://www.flickr.com/photos/gregpc/) (CC BY-NC-SA 2.0)

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

## Security Vulnerabilities
####Prerequisits

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.
- Download composer https://getcomposer.org/download/
- Download git https://git-scm.com/downloads

### License
####Prerequisits for Windows users

- Download XAMMP: https://www.apachefriends.org/download.html
- (Optional) Download and extract cmder mini: https://github.com/cmderdev/cmder/releases/download/v1.1.4.1/cmder_mini.zip
- Update windows environment variable path to point to your php install folder (inside XAMMP installation dir) (here is how you can do this http://stackoverflow.com/questions/17727436/how-to-properly-set-php-environment-variable-to-run-commands-in-git-bash)

####Mac Os, Ubuntu and Windows

The Laravel framework is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT)
1. Create a local database named `friendzone` with encoding utf8_general_ci
2. Create user `friendzone` and grant all rights on `friendzone` and for creating databases
3. cd to your local target folder and clone remote project: `git clone git://github.com/wi-wissen/friendzone.git`
4. Rename `.env.example` file to `.env`inside your project root and fill in the database information.
(windows won't let you do that, so you have to use Notepad++ or open your console, cd your project root directory and run `mv .env.example .env` )
5. Edit `.env`
- `APP_ENV=production`
- `APP_DEBUG=false` - enable only temporaly for debugging!
- `DB_*` - if you want another database than MySQL, you have to edit source code.
- `DB_USERNAME` - user for database
- `DB_PASSWORD` - passwort for database
- `MAIL_*` - mail provider for resetting passworts (admin accounts may reset passworts without sending a mail)
- `PHPMYADMIN` - url for opening phpMyAdmin - Example: https://friendzone.wi-wissen.de/phpmyadmin
6. Open the console and cd to your project root directory
7. Run `composer install` or ```php composer.phar install```
8. Run `php artisan key:generate`
9. Run `php artisan migrate`
10. Run `php artisan db:seed` to run seeders, if necessary.
11. Visit website and create first user.
12. In the `user` table of your database, manually set the attribute `is_admin` to `1`. Now your user is admin and may manage other accounts.

### Contributing
Thank you for considering contributing to the friendzone! Create a pull request or contact [me](https://wi-wissen.de/contact.php).

### License
[Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0)](https://creativecommons.org/licenses/by-nc-sa/4.0/)
Contact [me](https://wi-wissen.de/contact.php) if you need an other licence.

0 comments on commit 54d6075

Please sign in to comment.