diff --git a/01---Install.md b/01---Install.md index d739db3..928edd0 100644 --- a/01---Install.md +++ b/01---Install.md @@ -1,5 +1,5 @@ # The Setup - +## For Blogging If you're using Fipamo on a server to host and serve, it doesn't care what kind of web server you have. Just set up a reverse proxy so it knows where to find your site and hook it up to our domain. There are a couple examples below to get you started Once that is done, grab a copy of the latest [release](https://code.playvicio.us/Are0h/Fipamo/releases) or clone `git clone https://code.playvicio.us/Are0h/Fipamo.git --branch beta-release your-folder` (replace 'your-folder' with whatever you want) it to make it easier to update. @@ -8,6 +8,14 @@ Go into the directory you dumped in and run `npm install` so it grabs all the st Up and running? [Learn how to use Fipamo.](https://code.playvicio.us/Are0h/Fipamo/wiki/02-Usage) +## For Dev Collaboration +To contribute to Fipamo, you're going to need to grab a copy of the `develop` branch. Do that with `git clone https://code.playvicio.us/Are0h/Fipamo.git`. Also make sure you have [nodemon](https://nodemon.io/) installed as that what the development branch useses to spark up the server and reset the server when changes are made. Run `npm install -g nodemon` and your all set. + +Once you have a copy, jump into the directory and run `npm install` to grab everything the branch needs to run. + +From here there are two commands that need to run to create the scripts and css assets that dashboard needs and monitor further changes to update to those assets when changes are made. The first is `npm run watch`. This will keep an eye on stylus and script edits and render those assets accordingly. The second is `npm run dev` and this will start up the server and monitor changes that are made to core functionality and restart the server when needed. Both of these scripts will run in the background while code edits are being made. To see those changes, go to `http://localhost:2314/@/dashboard`. + + **Reverse Proxy for NGINX** ``` server {