Skip to content
This repository has been archived by the owner on Jun 28, 2023. It is now read-only.

Home

Jump to bottom
Kyle Klaus edited this page Oct 8, 2017 · 2 revisions

Welcome to the solder wiki!

This is intended as a temporary place to document the project until a full documentation site can be deployed

Developer / Local Install

If you want to test out solder, or want to hack on it these are the basic steps required to get it running. I highly recommend you use Laravel Valet for local development. If you're a windows user then Laravel Homestead is your best bet for success.

  • Clone the repository to your computer git clone https://github.com/indemnity83/solder
  • Install the application dependencies composer install
  • If you're going to do any development on stylesheets or javascript install the node dependencies with either of the following commands: yarn (recommended, its way faster) or npm install
  • Copy the .env.example file to .env
  • Generate an application key with the command php artisan key:generate
  • Edit the .env file to suite your environment (only thing you likely need to change is database info)
  • Migrate database tables and create the default admin user with php artisan migrate --seed
  • And finally generate API security keys with php artisan passport:keys

You should not have a fully functional local deployment!

Testing / Public Install with Laravel Forge

The easiest way to deploy and manage a public install is through Laravel Forge. It's not free, but it easily pays for itself in the time it will save you managing servers and deploying applications.

  • Create a new site for solder as General PHP / Laravel and leave the web directory as /public
  • Once the site is created, deploy it as a git repository
    • provider: GitHub
    • repository: indemnity83/solder
    • branch: master
    • Uncheck install composer dependencies (this is important, it will fail if you forget to uncheck this)
  • Once the repository is installed, change the deploy script by adding --no-dev to the composer options (the line should look like composer install --no-interaction --prefer-dist --optimize-autoloader --no-dev)
  • Finally, hit the Deploy Now button (Note that this script is set to wipe out the database each time it deploys!)

API Documentation

Clone this wiki locally