Skip to content

Commit

Permalink
Release v1.4.1 (#235)
Browse files Browse the repository at this point in the history
* Fix workflow

* Add flush doc command 

Adds testing section to README.md

* broken link fix

* Ignore .DS_Store files

* Updating community.md: 1) remove broken link, 2) add Google Calendar reaction calendar link. Editing: Don't use etc.

* typo

* fix connectors gitter channel url

* add missing label for Community Guidelines so it's not a ghost link anymore.

* Updated requirements doc/format

- updated requirements

* Updated examples using prop-types

* Remove OS links

* add instagram to the login services how to

* formatting

* add screenshot

* add to toc

* add image

* complete screenshot + instructions

* minor edits for style
  • Loading branch information
machikoyasuda authored Jul 25, 2017
1 parent 0bd6ba1 commit cc63f6a
Show file tree
Hide file tree
Showing 15 changed files with 129 additions and 99 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
.DS_Store
.idea
node_modules
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ npm install

If you're using [Atom](https://atom.io), you can install the supported plugin [linter-markdown](https://atom.io/packages/linter-markdown) to get linting feedback as you write. If you're using a different editor, see the list of [available editor integrations](https://github.com/wooorm/remark-lint#editor-integrations).

#### Usage
### Linting

```sh
# get lint results for the whole repo in your console
Expand All @@ -27,3 +27,15 @@ npm run lint
# fix anything that can be fixed automatically
npm run lint-fix
```

### Testing

You can view and test your branch live on https://docs.reactioncommerce.com/.

1. Go to https://docs.reactioncommerce.com/
2. Open browser console and run:

```js
Meteor.call("redoc/flushDocCache")
```
3. Find your branch in the drop-down menu. The URL should change to https://docs.reactioncommerce.com/reaction-docs/your-branch-name/intro and you should be able to see and test your changes here.
24 changes: 0 additions & 24 deletions admin/accounts.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,27 +21,3 @@ To configure member permissions, click on the arrow icon, located at the bottom
Toggle each feature on and off to allow or deny member access. If a feature is turned off, it will not be visible on that member's dashboard.

![](/assets/admin-accounts-manage.png "Reaction Commerce Dashboard")

## Manage Guest Settings

Customize the shopping experiences of your registered guest shoppers, from login to checkout.

To enable users to sign in with their Facebook, Google, or Twitter accounts, click on the cogwheel icon of the Accounts card.

![](/assets/admin-dashboard-accounts-wheel.png "Reaction Commerce Dashboard")

By default, all third-party sign ins are turned off. To enable or disable sign ins, simply toggle each feature on or off.

![](/assets/admin-accounts-settings.png "Reaction Commerce Dashboard")

To enable Facebook sign in, turn the Facebook toggle on. You'll be prompted to enter your own developer App ID and App Secret. Get your App ID and learn more about Facebook APIs by visiting [Facebook for Developers](https://developers.facebook.com/apps).

![](/assets/admin-accounts-settings-fb.png "Reaction Commerce Dashboard")

To enable Google sign in, turn the Google toggle on, and enter your Client ID and Client Secret. Get your Client ID and learn more about Google's APIs by visiting the [Google API Console](https://console.developers.google.com/projectselector/apis/library?pli=1).

![](/assets/admin-accounts-settings-google.png "Reaction Commerce Dashboard")

To enable Twitter sign in, turn the Twitter toggle on, and enter your Twitter API key and secret. To create an API key, visit [Twitter Application Management](https://apps.twitter.com/).

![](/assets/admin-accounts-settings-twitter.png "Reaction Commerce Dashboard")
40 changes: 40 additions & 0 deletions admin/login-services.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Login services

Enable shoppers to register and log into your store with third-party login services, including Facebook and Google. By default, all third-party sign-ins are turned off. Enabling a third-party login service adds a button under the **Sign In** panel.

![Adding third-party login services to Reaction](/assets/admin-login-services.png)

Before getting started, make sure you are logged in as an operator and click the **Login Services** icon in the Dashboard sidebar.

![Enable login services from Reaction Dashboard](/assets/admin-dashboard-login-services.png)

To add a login service, follow these steps:

## Facebook

1. Click the **Facebook Sign In** toggle to open the login panel.
2. Register your app at [Facebook for Developers](https://developers.facebook.com/apps) to get your App ID and Secret.
3. Enter your App ID and App Secret. Click **Update Settings**.
4. Sign out of your admin account. Click **Sign In**. This setting adds a **Sign in with Facebook** button as **Sign In** and **Register** options.

## Instagram

1. Click the **Instagram Sign In** toggle to open the login panel.
2. Register your app at [Instagram for Developers](https://www.instagram.com/developer/) to get your App ID and Secret.
3. Enter your App ID and App Secret. Click **Update Settings**.
4. Sign out of your admin account. Click **Sign In**. This setting adds a **Sign in with Instagram** button as **Sign In** and **Register** options.

## Google

1. Click the **Google Sign In** toggle to open the login panel.
2. Register your app [Google API Console](https://console.developers.google.com/projectselector/apis/library?pli=1) to get your Client ID and Secret.
3. Enter your Client ID and Client Secret. Click **Update Settings**.
4. Sign out of your admin account. Click **Sign In**. This setting adds a **Sign in with Google** button as **Sign In** and **Register** options.


## Twitter

1. Click the **Twitter Sign In** toggle to open the login panel.
2. Register your app at [Twitter Application Management](https://apps.twitter.com/) to get your API key and Secret.
3. Enter your API key and Secret. Click **Update Settings**.
4. Sign out of your admin account. Click **Sign In**. This setting adds a **Sign in with Twitter** button as **Sign In** and **Register** options.
Binary file added assets/admin-dashboard-login-services.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/admin-login-services.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 7 additions & 8 deletions developer/community.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@

Welcome to the Reaction community!

This is the starting point for becoming a contributor - improving docs, improving code, giving talks etc.
This is the starting point for becoming a contributor - improving docs, improving code, and giving talks.

Participating in our Gitter channels, our planning meetings, are welcome contributions to Reaction.
Participating in our Gitter channels and our planning meetings are welcome contributions to Reaction.

If you'd like to contribute code, you'll want to review the [contribution guidelines](contributing.md) and the [code styleguide](styleguide.md).
If you'd like to contribute code and issues, you'll want to review the [contribution guidelines](contributing.md).

## Roadmap

Reaction is a series of projects that combine the efforts of [community contributors](https://github.com/orgs/reactioncommerce/outside-collaborators) and core product development from the [@reactioncommerce](https://github.com/orgs/reactioncommerce/people) team.

A long term roadmap and completed features list is on our [features page](https://reactioncommerce.com/features).
A long-term roadmap and completed features list is on our [features page](https://reactioncommerce.com/features).

You will find these roadmap items defined as projects on the [Reaction repository's project page](https://github.com/reactioncommerce/reaction/projects).

Expand All @@ -21,15 +21,14 @@ Specific features in progress are found grouped on the [Reaction repository's mi
## Projects

Reaction projects can have both @core leads as well as community leads.
Chat channels and meetings are open to all.
Chat channels and meetings are open to all. Here's our [Reaction Community Google Calendar](http://getrxn.io/2rcCal) with all of the meetings and Reaction Action events.

| Name | Leads | Gitter Channel | [Schedule](http://getrxn.io/2rcCal) |
| Name | Leads | Gitter Channel | Schedule |
| ------------------- | ----------------------- | ---------------------------------------------------------------------------------- | ----------------------------------------- |
| Connectors, Catalog | @aaronjudd @jshimko | [reactioncommerce/catalog](https://gitter.im/reactioncommerce/catalog) | Every 2 weeks on Wednesday 2PM Pacific |
| Connectors, Catalog | @aaronjudd @jshimko | [reactioncommerce/connectors](https://gitter.im/reactioncommerce/connectors) | Every 2 weeks on Wednesday 2PM Pacific |
| Core | @aaronjudd | [reactioncommerce/core](https://gitter.im/reactioncommerce/core) | Every 2 weeks on Wednesday 2PM Pacific |
| Components | @mikemurray @kieckhafer | [reactioncommerce/components](https://gitter.im/reactioncommerce/components) | Every 2 weeks on Tuesday 3PM Pacific |
| Deployment | @jshimko | [reactioncommerce/deployment](https://gitter.im/reactioncommerce/deployment) | Every 2 weeks on Thursday 10AM Eastern |
| Design | @rymorgan | [reactioncommerce/design](https://gitter.im/reactioncommerce/design) | Every 2 weeks on Wednesday 3PM Pacific |
| Documentation | @machikoyasuda | [reactioncommerce/documentation](https://gitter.im/reactioncommerce/documentation) | Monthly on the Fourth Tuesday 3:30PM Pacific |
| Marketplace | @spencern | [reactioncommerce/marketplace](https://gitter.im/reactioncommerce/marketplace) | Every 2 weeks on Wednesday 7AM Pacific |

4 changes: 2 additions & 2 deletions developer/components/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ Reaction UI components using Blaze and React.
Below is a basic example of how a component should look. Components should be reusable without any dependencies on Meteor, database, session, trackers, composeWithTracker or redux connect if possible. There are a few exceptions, however, fetching from the database is best served from a higher order component.

```js
import React, { Component, PropTypes } from "react";
import React, { Component } from "react";
import PropTypes from "prop-types";

class MyComponent extends Component {
// Default props, (optional)
Expand Down Expand Up @@ -42,5 +43,4 @@ class MyComponent extends Component {
}

export default MyComponent;

```
21 changes: 11 additions & 10 deletions developer/components/slider.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ import { Slider } from "/imports/plugins/core/ui/client/components";
## Usage Example

```javascript
import React, { Component, PropTypes } from "react";
import React, { Component } from "react";
import PropTypes from "prop-types";
import { Slider } from "/imports/plugins/core/ui/client/components";

class MyComponent extends Component {
Expand Down Expand Up @@ -45,14 +46,14 @@ export default MyComponent;

## Props

Property | Type | Description
-------- | -------- | --------------------------------------------------------------------------------------
range | Object | `{ min: Number, max: Number }`
start | Array | Start point for handles
margin | Number | Margin between handles
connect | Boolean | Display a colored bar between the handles
step | Number | Amount to move handles when dragging
onChange | Function | Callback when slider changed<br>`(values, handle, unencoded, tap, positions) => {}`
onSlide | Function | Callback when slider is changing<br>`(values, handle, unencoded, tap, positions) => {}`
| Property | Type | Description |
| -------- | -------- | --------------------------------------------------------------------------------------- |
| range | Object | `{ min: Number, max: Number }` |
| start | Array | Start point for handles |
| margin | Number | Margin between handles |
| connect | Boolean | Display a colored bar between the handles |
| step | Number | Amount to move handles when dragging |
| onChange | Function | Callback when slider changed<br>`(values, handle, unencoded, tap, positions) => {}` |
| onSlide | Function | Callback when slider is changing<br>`(values, handle, unencoded, tap, positions) => {}` |

More props at <https://refreshless.com/nouislider/>
3 changes: 2 additions & 1 deletion developer/module-cheatsheet.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,8 @@ import { Translatable } from "/imports/plugins/core/ui/client/providers";
### React

```javascript
import React, { Component, PropTypes } from "react";
import React, { Component } from "react";
import PropTypes from "prop-types";
```

### Utils
Expand Down
91 changes: 42 additions & 49 deletions developer/requirements.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
# Requirements

Reaction is built with [Meteor](https://meteor.com) and requires [Node.js](https://nodejs.org/) (v4 or higher). See the instructions for your operating system below.
Reaction is built using [Meteor](https://meteor.com) and requires [Node.js](https://nodejs.org/) (v4 or higher).

- [macOS](#macos)
- [Linux](#linux)
- [Windows](#windows)
We recommend at least **2GB of memory** for Node and Reaction to run well.

## Required

### Node.js and npm

<https://nodejs.org>

If you have node and npm already installed, install the [reaction-cli](https://www.npmjs.com/package/reaction-cli) from [npm](https://www.npmjs.com/).

Expand All @@ -15,13 +19,17 @@ npm install -g reaction-cli

`reaction -h` provides a list of commands.

## macOS
### Meteor

**Node.js**
`reaction-cli` will prompt you to install Meteor, if you have not already installed it.

<https://nodejs.org>
```sh
curl https://install.meteor.com/ | sh
```

### Build Tools

**Build Tools**
**macOS**

Install [Xcode](https://developer.apple.com/xcode/downloads/), then run `xcode-select --install`

Expand Down Expand Up @@ -49,12 +57,6 @@ sudo sysctl -w kern.maxfilesperproc=65536
ulimit -n 65536 65536
```

**Meteor**

```sh
curl https://install.meteor.com/ | sh
```

**Homebrew**

```sh
Expand All @@ -69,21 +71,7 @@ ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/
brew install git
```

**ImageMagick**

ImageMagick installation is optional, but is highly recommended, as it is used for image resizing on upload.

```sh
brew install imagemagick
```

## Linux

**Node.js**

<https://nodejs.org/>

**Build Tools**
### Linux

```sh
# Ubuntu/Debian
Expand All @@ -95,27 +83,13 @@ apt-get install -y --no-install-recommends build-essential bzip2 curl ca-certifi

```sh
# CentOS/RHEL

# build tools
yum groupinstall "Development Tools"

# add "Extra Packages for Enterprise Linux" repository for GraphicsMagick
yum install epel-release

yum install GraphicsMagick
```

**Meteor**

```sh
curl https://install.meteor.com/ | sh
yum install epel-release GraphicsMagick
```

## Windows

**Node.js**

<https://nodejs.org/>
### Windows

**Windows Build Tools 2015**

Expand All @@ -131,16 +105,35 @@ npm install -g windows-build-tools

<https://github.com/git-for-windows/git/releases>

**Meteor**

<https://www.meteor.com/install>
## Optional

**ImageMagick**
### ImageMagick

ImageMagick installation is optional, but is highly recommended, as it is used for image resizing on upload.

**Windows**

<https://www.imagemagick.org/script/binary-releases.php#windows>

**macOS**

```sh
brew install imagemagick
```

## bcrypt

Installing a local native compiled version of `bcrypt` is optional, but may yield some performance benefits and is recommended for production environments.

Note: you are using a pure-JavaScript implementation of bcrypt.
While this implementation will work correctly, it is known to be
approximately three times slower than the native implementation.
In order to use the native implementation instead, run

meteor npm install --save bcrypt

in the root directory of your application.

## MongoDB

[MongoDB](https://www.mongodb.org/) is bundled with the Meteor development environment, so you don't need to install it manually for local development. When the development server is running, you can connect to the local MongoDB instance on the port that is one higher than the port Meteor is running on (e.g. if Meteor is running on port 3000, MongoDB will be on port 3001). No credentials are required to connect to Mongo while running in development.
Expand Down
2 changes: 1 addition & 1 deletion developer/testing/ci.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ When successful, Docker images are also pushed to [Docker Hub](https://hub.docke

Automated duplication, security, style review using Code Climate.

Follows project `eslint` and [style guide](/developer/styleguide.md) guide.
Follows project `eslint` and [Reaction style guide](/developer/styleguide.md).

## Code Review

Expand Down
4 changes: 2 additions & 2 deletions developer/tutorial/plugin-layouts-3.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ We also need to add our layout to the registry via our `register.js`. We are goi
```js
layout: [{
layout: "coreLayoutBeesknees",
workflow: "coreProductWorkflow",
workflow: "coreProductGridWorkflow",
collection: "Products",
theme: "default",
enabled: true,
Expand Down Expand Up @@ -118,7 +118,7 @@ Reaction.registerPackage({
autoEnable: true,
layout: [{
layout: "coreLayoutBeesknees",
workflow: "coreWorkflow",
workflow: "coreProductGridWorkflow",
collection: "Products",
theme: "default",
enabled: true,
Expand Down
2 changes: 1 addition & 1 deletion guidelines/faqs.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Any event that we fund will have some sort of anti-harassment policy in place. T

## What happens if someone violates the Code of Conduct?

Our intent is that the anyone in the community can stand up for this code, and direct people who're unaware to this document. If that doesn't work, or if you need more help, you can contact [[email protected]](mailto:[email protected]). For more details please see our [Reporting Guidelines](/guidelines/reporting-guidelines.md).
Our intent is that the anyone in the community can stand up for this code, and direct people who're unaware to this document. If that doesn't work, or if you need more help, you can contact [[email protected]](mailto:[email protected]). For more details please see our [Reporting Guidelines](/guidelines/reporting-guide.md).

## Why do we need a Code of Conduct? Everyone knows not to be a jerk.

Expand Down
Loading

0 comments on commit cc63f6a

Please sign in to comment.