Skip to content
This repository has been archived by the owner on Jul 20, 2022. It is now read-only.
/ speedest Public archive
generated from a2insights/octo

🏃 Keep running with the Speedest

License

Notifications You must be signed in to change notification settings

moka-soft/speedest

Repository files navigation

Speedest

GitHub license

PRs and issues is welcome!


Getting started

Installation

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

Clone the repository:

git clone https://github.com/moka-soft/speedest.git

Switch to the repo folder:

cd speedest

Install all the dependencies using composer:

composer install

Install all the node dependencies using npm:

npm install

Compile the css and javascript assets:

npm run dev #For local
npm run prod #For Production

Install required application things:

php artisan speedest:install

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

cp .env.example .env
  • Social login: If you want to activate the social login make sure if you put the follows credentials below.
GITHUB_CLIENT_ID=
GITHUB_CLIENT_SECRET=
GITHUB_CLIENT_CALLBACK=

Generate a new application key:

php artisan key:generate

Flush de application cache:

php artisan cache:clear
php artisan route:clear
php artisan config:clear
php artisan view:clear
php artisan optimize

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

php artisan migrate

Start the local development server:

php artisan serve

Demo Application:

You can set faker data using our assistant:

php artisan speedest:setup

This will create a user with the follow credentials:

E-mail: [email protected]

Password: UsainBolt

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

TL;DR command list

git clone https://github.com/Atiladanvi/speedest.git
cd speedest
composer install
npm install
npm run dev
cp .env.example .env
php artisan speedest:install
php artisan cache:clear
php artisan route:clear
php artisan config:clear
php artisan view:clear
php artisan optimize
php artisan migrate
php artisan serve

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

Using Docker

Default: mysql

Make sure if you have docker-compose installed and perform this command:

Set database environment like this:

DB_CONNECTION=mysql
DB_HOST=mysql
DB_PORT=3306
DB_DATABASE=speedest
DB_USERNAME=root
DB_PASSWORD=

PS: Check if you can execute docker commands: https://docs.docker.com/engine/install/linux-postinstall

Up de docker services:

./vendor/bin/sail up -d

For the first time you need install dependencies, compile assets, install speedest, flush the cache, migrate & seed database:

./vendor/bin/sail composer install
./vendor/bin/sail npm install
./vendor/bin/sail npm run dev
./vendor/bin/sail artisan speedest:install
./vendor/bin/sail artisan cache:clear
./vendor/bin/sail artisan route:clear
./vendor/bin/sail artisan view:clear
./vendor/bin/sail artisan optimize
./vendor/bin/sail artisan migrate
./vendor/bin/sail artisan db:seed

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

Demo application:

You can set up the new application with faker data using our assistant:

./vendor/bin/sail artisan speedest:setup

This will create a user with the follow credentials:

E-mail: [email protected]

Password: UsainBolt

Down the service:

./vendor/bin/sail down

For more information: https://laravel.com/docs/sail

Troubleshooting:

Prune docker

https://docs.docker.com/engine/reference/commandline/system_prune/

Need rebuild?

./vendor/bin/sail build --no-cache

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

Credits

License

The MIT License. Please see license file for more information.

Releases

No releases published

Packages

No packages published