This is the repository for Astral v2. Currently looking for core contributors!
- Improved Caching
- Improved UI/UX
- Built on Laravel 5.4
- Switched the front-end from AngularJS to VueJS
-
Fork this repository, clone it, and
cd
into it -
Install the front-end dependencies:
yarn
ornpm install
-
Install the PHP dependenices:
composer install
-
Configure Homestead:
homestead edit
[...] folders: - map: ~/<PATH TO REPO> to: /home/vagrant/astral sites: - map: astralapp.app to: /home/vagrant/astral/public databases: - astral [...]
-
Add the local development domain to your hosts file:
192.168.10.10 astralapp.app
-
Create a new GitHub personal access token, and grab the keys it gives you
-
Copy the
.env.example
file and rename it to.env
. Add your GitHub keys to it -
SSH into your Homestead app, migrate the DB, and generate a new app key
$ homestead ssh $ cd astral $ php artisan migrate $ php artisan key:generate
-
Fire up the app! Open a browser at http://astralapp.app/ and bask in its glory!
-
Fork this repository, clone it recursively including submodules, and
cd
intolaradock
folder -
Execute Docker Compose:
docker-compose up -d nginx mysql redis
-
Run a terminal inside workspace container:
docker-compose exec workspace bash
-
Change to
laradock
user:su laradock
-
Install the front-end dependencies:
npm install
-
Install the PHP dependencies:
composer install
and exit container -
Add the local development domain to your hosts file:
your_ip astralapp.app
-
Create a new OAuth Application, and grab the keys it gives you
-
Copy the
.env.example
file and rename it to.env
. Add your GitHub keys to it -
Run a terminal into your
workspace
container again, migrate the DB, and generate a new app key$ php artisan migrate $ php artisan key:generate
-
Fire up the app! Open a browser at http://astralapp.app/ and bask in its glory!
Astral uses JS and SCSS that needs to be transpiled before use. There are various NPM tasks available to you to make this easy.
- When developing you often want to watch files for changes, and re-bundle automatically. You'll want to run either
npm run watch
ornpm run hot
. Thewatch
command is a standard file watcher, andhot
will give you hot module reloading. - To get the bundle production ready, run
npm run production
. This will generate production-ready JS and CSS assets. - Consult the
package.json
file for other NPM scripts you can use.
- Get up and running
- Create a new descriptively-named branch
- Commit your changes and push to your fork.
- Create a pull request with a clear, well written description of what the PR is all about. You should always run
npm run production
and commit the results before creating the PR. - Party!!