RodrigoPauletti / suggestion-system

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Suggestion System

Suggestion system is a system where users can submit suggestions and vote on suggestions sent by other users.

Getting started

Installation

Please check the official laravel installation guide for server requirements before you start. Official Documentation

Alternative installation is possible without local dependencies relying on Docker.

Clone the repository

git clone git@github.com:RodrigoPauletti/suggestion-system.git

Switch to the repo folder

cd suggestion-system

Install all the dependencies using composer

composer install

Copy the example env file and make the required configuration changes in the .env file

cp .env.example .env

Generate a new application key

php artisan key:generate

Run the database migrations (Set the database connection in .env before migrating)

php artisan migrate

Build the assets

npm install
npm run build

Start the local development server

php artisan serve

You can now access the server at http://localhost:8000

TL;DR command list

git clone git@github.com:RodrigoPauletti/suggestion-system.git
cd suggestion-system
composer install
cp .env.example .env
php artisan key:generate
npm install
npm run build

Make sure you set the correct database connection information before running the migrations Environment variables

php artisan migrate
php artisan serve

Database seeding

Populate the database with seed data with relationships which includes users, articles, comments, tags, favorites and follows. This can help you to quickly start testing the api or couple a frontend and start using it with ready content.

Run the database seeder and you're done

php artisan db:seed

Note : It's recommended to have a clean database before seeding. You can refresh your migrations at any point to clean the database by running the following command

php artisan migrate:refresh

Docker

To install with Docker, run following commands:

git clone git@github.com:RodrigoPauletti/suggestion-system.git
cd suggestion-system
cp .env.example .env
docker-compose up -d

The commands below needs wait until composer install all depencies

docker-compose exec suggestion_system_server php artisan key:generate
docker-compose exec suggestion_system_server php artisan migrate
docker-compose exec suggestion_system_server php artisan db:seed
docker-compose exec suggestion_system_server npm install
docker-compose exec suggestion_system_server npm run build

Environment variables

  • .env - Environment variables can be set in this file

Note : You can quickly set the database information and other variables in this file and have the application fully working.

License

The Laravel framework is open-sourced software licensed under the MIT license.

About

License:MIT License


Languages

Language:PHP 63.4%Language:Blade 29.7%Language:Less 3.4%Language:JavaScript 2.9%Language:Dockerfile 0.5%Language:CSS 0.2%