Linkit

Description:

A web app where users post links and leave comments. Built with Laravel and sakura.css

Installation:

Note: I wrote these instructions for systems with docker installed because it removes most of the hassle of obtaining dependencies and configuration.

If you already have Laravel dependencies, installed composer globally, and a laravel supported database, then just follow step 1, configure the .env file with your database credentials, do step 7 in the project directory and php artisan serve

Installation with docker

Requirements:

docker and docker-compose working in your host system

Follow these steps in your host terminal:

1. clone this repo, goto the directory and rename the env file:

   user@host:~$ git clone https://github.com/cruzken/linkit.git && cd linkit && cp .env.example .env

2. clone laradock repo, goto the directory and rename the env file:

   user@host:~/linkit$ git clone https://github.com/laradock/laradock/ && cd laradock && cp env-example .env

3. change the line MYSQL_VERSION=latest in laradock/.env to: MYSQL_VERSION=5.7

4. Open linkin/.env and set DB_HOST value to: mysql

   1. for DB_DATABASE, DB_USERNAME, DB_PASSWORD match the values set in laradock/.env MYSQL_DATABASE, MYSQL_USER, MYSQL_PASSWORD

5. start building the containers:

   user@host:~/linkit/laradock$ docker-compose up -d nginx mysql workspace

6. access the workspace container:

   user@host:~/linkit/laradock$ docker-compose exec workspace bash

7. in the workspace container initialize the app:

   root@foo:/var/www# composer install && php artisan key:generate && php artisan migrate

Usage

• If installed without docker, run php artisan serve in the project directory.
• Go to the local address that the app is served in the browser (usually localhost or localhost:8000)
• Register user accounts, submit links, and post comments!

Contributing

There is no contributing guide (yet?) Feel free to submit pull requests for fixes, features, etc.

Credits

Thanks to the Laravel team for their amazing framework. Thanks to the Laradock team for their docker environment configuration. Thanks to oxalorg for the elegant classless css theme.

License

This is open-sourced software licensed under the MIT license.