README - ermahgerd-emberjs-cognito

This Ember application talks to a Rails API server over at https://github.com/cybertooth-io/ermahgerd-rails-api-cognito.

Development - Getting Started

You need the following:

Git
Yarn
Node.js - consider using NVM
Ember CLI - make sure to install the CLI yarn global ember-cli
Google Chrome - unit tests run through testem require Chrome

First Time Setting Up

git clone git@github.com:cybertooth-io/ermahgerd-emberjs-cognito.git - to download the code
cd ermahgerd-emberjs-cognito - to get into the checked out code
yarn or yarn install - will install all javascript libraries

Running The Server

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.

While your Ember server is running, feel free to check out the tests by visiting http://localhost:4200/tests.

Testing

Ember comes with linters and qunit testing.

ember t - will run the tests once in your console

ember t -s - will run the tests in a new Chrome window and watch for changes

ember t -s --filter='role' - will run tests only tests with the word role in their path

Linting

yarn run lint:hbs
yarn run lint:js
yarn run lint:js -- --fix

Development Workflow

Code Generators

Make use of the many generators for code, try ember help generate for more details

...More Coming soon

Deployment

Configuration Notes

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!

# Font Awesome
ember install @fortawesome/ember-fontawesome
yarn add --dev @fortawesome/free-solid-svg-icons
yarn add --dev @fortawesome/free-regular-svg-icons
yarn add --dev @fortawesome/free-brands-svg-icons

# Ember Select Boxes - this addon is great
ember install @zestia/ember-select-box

# For custom actions that aren't normal REST end points; e.g. `current-user` needs a `sign-out` endpoint.
ember install ember-api-actions

# For importing libraries (replaces ember-browserify); needed for: `import Auth from '@aws-amplify/Auth'
ember install ember-auto-import

# Bootstrap 4 support; bring it all in looks like bootstrap@^4.1.0 comes in, should be bootstrap@~4.1.0 
ember install ember-cli-bootstrap-4

# Get gravatar images
ember install ember-cli-gravatar

# SASS for stylesheets; make sure to renamed app/styles/app.css -> app/styles/app.scss
ember install ember-cli-sass

# Text and Textarea components that don't fail to autofocus
ember install ember-cli-text-support-mixins

# installing typescript to make life happy
ember install ember-cli-typescript

# Used to manipulate arrays template-side
ember install ember-composable-helpers

# install ember-decorators for dressing up your app with typescript; this stuff will eventually ship with Octane edition
ember install ember-decorators

# Used to format dates
ember install ember-helper-locale-date

# using QRCode.js to create QR codes for Authenticator apps (e.g. Google Authenticator)
ember install ember-qrcode-shim

# Encouraged to stop using this, but I actually love this helper
ember install ember-route-action-helper

# For authentication
yarn add @aws-amplify/core -D
yarn add @aws-amplify/auth -D

`config/environment.js`

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.

AWS Cognito & AWS Amplify Auth

Create an Ember Service that will read from the environment settings to configure the Cognito User Pool. See

cybertooth-io / ermahgerd-emberjs-cognito

readme