Skip to content

Latest commit

 

History

History
74 lines (49 loc) · 3.2 KB

cloning.md

File metadata and controls

74 lines (49 loc) · 3.2 KB

Cloning

NOTE: all commands should be run in a terminal/command prompt window. In general you'll have 2-3 terminal/command prompt windows open at once - one for running MongoDB (if not running by default / as a service), one for running node.js, and one for commands (mostly grunt)

Variables used in the instructions below; replace appropriately

GIT_NAME Joe Bob

GIT_EMAIL youremail@gmail.com

GIT_REPO_URL git@github.com:jackrabbitsgroup/my-app.git

GIT_REPO_URL_HTTPS https://github.com/jackrabbitsgroup/my-app.git

LOCAL_PARENT_FOLDER /website

LOCAL_FOLDER_NAME my-app

APP_DOMAIN localhost

APP_PORT 3000

  1. machine (global / program) installs (if you don't have them already)
    1. install git, nodejs, mongodb, phantomjs, java - see here for Mac or here for Windows or here for Linux
    2. sudo npm install -g grunt-cli yo bower generator-mean-seed yuidocjs forever less
    3. IF using Github (to clone/push/pull from), set it up:
      1. git config --global user.name "GIT_NAME"
      2. git config --global user.email GIT_EMAIL
      3. git config --global --add color.ui true
  2. Clone the Git repository
    1. In command prompt, navigate to the folder where you want the app to be created in
      1. cd LOCAL_PARENT_FOLDER
    2. git clone GIT_REPO_URL
    3. Go into your newly cloned directory: cd LOCAL_FOLDER_NAME
  3. [Maybe] Setup configs (see below)
  4. Do some setup / installs
    1. npm install && bower install
      1. NOTE: you'll have to re-run this any time package.json or bower.json changes
    2. grunt q to build assets
      1. NOTE: you'll have to re-run this any time a *.less (or _*.scss) or *.html file changes
    3. ./node_modules/protractor/bin/webdriver-manager update - for Protractor (local) tests
  5. start server and view app
    1. node run.js to start node server (make sure MongoDB is already running first)
      1. Type Ctrl + C to quit/stop
    2. open a browser to http://APP_DOMAIN:APP_PORT/ to view the site/app
  6. run tests (and confirm they all pass!)
    1. grunt
  7. optional additional steps: see extra-setup.md

Generators

Make sure to leverage the available (sub)generators - i.e. for creating new pages/routes/controllers, directives, and services! Run generators with yo mean-seed and then select the sub-generator you want to use!

https://github.com/jackrabbitsgroup/generator-mean-seed/blob/master/docs/generators/modules.md

Configs

See configs.md in the docs folder

More Info

See setup-detailed.md and running.md in the docs folder.

Note for (initial) developer(s):

These cloning steps above are for duplicating the app/website/code to OTHER servers/machines AFTER Yeoman has been run (once).

Give these steps to any fellow developers for them to get set up - they do NOT need to run Yeoman since you've already generated the app for them - the main generator for Yeoman only needs to be run ONCE (and later used for updates). Though other developers WILL use other Yeoman generators (i.e. for creating a new route), just not the main/core generator that builds the app from scratch the first time.