This repository has been archived by the owner on Jun 28, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 11
Home
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
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) ornpm 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!
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 in two places:
- First by adding
--no-dev
to the composer options (the line should look likecomposer install --no-interaction --prefer-dist --optimize-autoloader --no-dev
) - Second, set the database migration to include a seeder by adding
--seed
to the migrate line (the line should look likephp artisan migrate --seed
)
- First by adding
- Finally, hit the
Deploy Now
button
API Documentation