Skip to content

Latest commit

 

History

History
94 lines (67 loc) · 3.76 KB

develop_setup.md

File metadata and controls

94 lines (67 loc) · 3.76 KB

< Develop

Setup Your Development Environment

In order to develop for the OpsPortal, you need to install the following packages:

First, make sure you download and install Git and Mysql. Then download the appropriate NodeJS package and install it. Once that is done, you will also have a command line tool called npm

Note: Windows users will need to run their command line tool in Administrator mode. After you install Git, you should have access to 'Git Bash'. Right click on the icon (probably on your desktop), and select "run as administrator". Note: If your using a unix environment, I'd recommend taking a moment to read through this article and see how they setup npm to not require using sudo. (it is the section called Changing the Location of Global Packages) While not necessary, it could save you some additional headaches.

The rest of the setup can be done from the command line:

$ npm install -g sails@0.12.3
$ npm install -g appdevdesigns/appdev-cli

Now we simply need to run the appdev install tool:

Note: if you are using Mysql you will be asked for a Database to use. Make sure you have already created that DB before running this install command.

$ cd your/development/directory
$ appdev install sails --develop
    # you will be asked numerous configuration questions.  
    # In many cases you can simply [enter] to accept the default 
    # options that are displayed in the ():
    #     mysql : setup according to typical MAMP settings
    #     SSL   : no
    #     auth  : local

Alternatively, if you are the kind of person who likes seeing how everything is done under the hood, then you can leave off the --develop parameter, and step through the process manually. Read how to do that here.

Test it out

Now test this out:

$ cd sails
$ sails lift

You should see a response like:

info: Starting app...

info: 
info: 
info:    Sails              <|
info:    v0.12.3             |\
info:                       /|.\
info:                      / || \
info:                    ,'  |'  \
info:                 .-'.-==|/_--'
info:                 `--'-------' 
info:    __---___--___---___--___---___--___
info:  ____---___--___---___--___---___--___-__
info: 
info: Server lifted in `/path/to/your/dir/sails`
info: To see your app, visit http://localhost:1337
info: To shut down Sails, press <CTRL> + C at any time.

debug: --------------------------------------------------------
debug: :: Fri Feb 13 2015 17:24:55 GMT+0700 (ICT)

debug: Environment : development
debug: Port        : 1337
debug: --------------------------------------------------------

Open a web browser and enter the path: localhost:1337/page/opsportal

Your first time to load this page, you will be presented with a Login Screen. The default login info is:

  • username: admin
  • password: admin

After you login, you should see a spiffy web page with a bar across the bottom for the Opsportal. Clicking on the bar will cause the OpsPortal to take over the whole screen. Clicking on the menu icon will allow you to switch between the installed OpsTools.

If you successfully got here, then you are ready to create your first OpsTool Plugin.

< Develop
Next: Create a Plugin >