-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
80 additions
and
38 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,62 +1,62 @@ | ||
| # cppdist-com-emberjs | ||
| # README - cppdist-com-emberjs | ||
|
|
||
| This README outlines the details of collaborating on this Ember application. | ||
| A short introduction of this app could easily go here. | ||
| The EmberJs application for Canadian Pump & Packing Distribution. This Ember application will talk to the Rails API | ||
| server over at [https://github.com/cybertooth-io/cppdist-com-rails](https://github.com/cybertooth-io/cppdist-com-rails). | ||
|
|
||
| ## Prerequisites | ||
| ## Development - Getting Started | ||
|
|
||
| You will need the following things properly installed on your computer. | ||
| You need the following: | ||
|
|
||
| * [Git](https://git-scm.com/) | ||
| * [Node.js](https://nodejs.org/) (with npm) | ||
| * [Ember CLI](https://ember-cli.com/) | ||
| * [Google Chrome](https://google.com/chrome/) | ||
| * [Yarn](https://yarnpkg.com/en/) | ||
| * [Node.js](https://nodejs.org/) - consider using [NVM](https://github.com/creationix/nvm) | ||
| * [Ember CLI](https://ember-cli.com/) - make sure to install the CLI `yarn global ember-cli` | ||
| * [Google Chrome](https://google.com/chrome/) - unit tests run through testem require Chrome | ||
|
|
||
| ## Installation | ||
|
|
||
| * `git clone <repository-url>` this repository | ||
| * `cd cppdist-com-emberjs` | ||
| * `npm install` | ||
| ### First Time Setting Up | ||
|
|
||
| ## Running / Development | ||
| 1. `git clone [email protected]:cybertooth-io/ccpdist-com-emberjs.git` - to download the code; `cd ccpdist-com-emberjs.git` to get into the checked out code | ||
| 1. `yarn` or `yarn install` - will install all javascript libraries | ||
|
|
||
| * `ember serve` | ||
| * Visit your app at [http://localhost:4200](http://localhost:4200). | ||
| * Visit your tests at [http://localhost:4200/tests](http://localhost:4200/tests). | ||
| ### Running The Server | ||
|
|
||
| ### Code Generators | ||
| `ember s --proxy=http://localhost:3000` - runs the server and proxies all Ember Data | ||
| requests to `http://locahost:3000` (that's a Rails API server). Find your app | ||
| at [http://localhost:4200](http://localhost:4200). | ||
|
|
||
| Make use of the many generators for code, try `ember help generate` for more details | ||
| While your Ember server is running, feel free to check out the tests by | ||
| visiting [http://localhost:4200/tests](http://localhost:4200/tests). | ||
|
|
||
| ### Testing | ||
|
|
||
| Ember comes with linters and qunit testing. | ||
|
|
||
| `ember t` - will run the tests once in your console | ||
|
|
||
| ### Running Tests | ||
| `ember t -s` - will run the tests in a new Chrome window and watch for changes | ||
|
|
||
| * `ember test` | ||
| * `ember test --server` | ||
| `ember t -s --filter='role'` - will run tests only tests with the word _role_ in their path | ||
|
|
||
| ### Linting | ||
|
|
||
| * `npm run lint:hbs` | ||
| * `npm run lint:js` | ||
| * `npm run lint:js -- --fix` | ||
| * `yarn run lint:hbs` | ||
| * `yarn run lint:js` | ||
| * `yarn run lint:js -- --fix` | ||
|
|
||
| ### Building | ||
| ### Development Workflow | ||
|
|
||
| * `ember build` (development) | ||
| * `ember build --environment production` (production) | ||
| #### Code Generators | ||
|
|
||
| ### Deploying | ||
| Make use of the many generators for code, try `ember help generate` for more details | ||
|
|
||
| Specify what it takes to deploy your app. | ||
| _...More Coming soon_ | ||
|
|
||
| ## Further Reading / Useful Links | ||
| ## Deployment | ||
|
|
||
| * [ember.js](https://emberjs.com/) | ||
| * [ember-cli](https://ember-cli.com/) | ||
| * Development Browser Extensions | ||
| * [ember inspector for chrome](https://chrome.google.com/webstore/detail/ember-inspector/bmdblncegkenkacieihfhpjfppoconhi) | ||
| * [ember inspector for firefox](https://addons.mozilla.org/en-US/firefox/addon/ember-inspector/) | ||
| ### Configuration Notes | ||
|
|
||
| ## Addons | ||
| #### Addons | ||
|
|
||
| Please use this section to mention the addons that we've been installing that way if we do an upgrade | ||
| and need to bring them all back we can! | ||
|
|
@@ -74,3 +74,29 @@ $ ember install ember-route-action-helper | |
| $ ember install ember-concurrency | ||
|
|
||
| ``` | ||
|
|
||
| #### `config/environment.js` | ||
|
|
||
| 1. `ember-simple-auth-token` is configured in here. Needs to match the token & cookie authentication paths in your API server. | ||
|
|
||
| ### Building | ||
|
|
||
| `ember b` - builds for your development environment | ||
|
|
||
| `ember build --environment production` - builds for production minifying and shrinking | ||
|
|
||
| _...More Coming soon_ | ||
|
|
||
| ## Contributing | ||
|
|
||
| Team members, create a branch and pull request. | ||
|
|
||
| General Public: Fork and create pull request. | ||
|
|
||
| ## Further Reading / Useful Links | ||
|
|
||
| * [ember.js](https://emberjs.com/) | ||
| * [ember-cli](https://ember-cli.com/) | ||
| * Development Browser Extensions | ||
| * [ember inspector for chrome](https://chrome.google.com/webstore/detail/ember-inspector/bmdblncegkenkacieihfhpjfppoconhi) | ||
| * [ember inspector for firefox](https://addons.mozilla.org/en-US/firefox/addon/ember-inspector/) | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters