Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add local config files #180

Merged
merged 23 commits into from
Apr 2, 2018
Merged

Add local config files #180

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
53f492d
Extract api and use different entry points
unDemian Mar 27, 2018
e4e5bbc
Add api file and new entry point for dist target
unDemian Mar 27, 2018
ff1d9ff
Remove dist files from repo
unDemian Mar 27, 2018
6e25b05
Rename dist to browser
unDemian Mar 27, 2018
1e163e5
Add npm commands for dev and fix hotrealoading
unDemian Mar 27, 2018
3a3986c
Use local css and configs for development
unDemian Mar 27, 2018
845bcd9
Address feedback
unDemian Mar 27, 2018
fbfc9cf
Update webpack.dist.config.js
unDemian Mar 27, 2018
e9934e2
Update package-lock to match master
unDemian Mar 28, 2018
e3a1930
Remove lodash-webpack-plugin
unDemian Mar 28, 2018
f0b492c
Address feedback
unDemian Mar 28, 2018
036a38b
Initial jsdocs for eventAPI
oandregal Apr 1, 2018
a8d1967
Fix merge conflicts
unDemian Apr 2, 2018
3a74514
Fix merge conflicts
unDemian Apr 2, 2018
237ec14
Fix merge conflicts
unDemian Apr 2, 2018
0c1a3bc
Remove dists
unDemian Apr 2, 2018
b6bb6d8
Fix merge conflicts
unDemian Apr 2, 2018
a45139b
Fix commands
unDemian Apr 2, 2018
2790e04
Fix targets npm command
unDemian Apr 2, 2018
595906e
Fix merge conflicts
unDemian Apr 2, 2018
e177c5f
Fix merge conflicts
unDemian Apr 2, 2018
ffeddf6
Update standalone
unDemian Apr 2, 2018
c4bf870
Fix merge conflicts
unDemian Apr 2, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
# Generic
node_modules/
*.map

# Project
tokens
targets/standalone/public/tokens
targets/standalone/public/happychat.css
targets/wordpress/assets/happychat.css
stats.json
*.local.json

# Targets dists
targets/**/happychat.css
targets/**/happychat.js
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ A JavaScript library to embed customer-facing Happychat in any host.

## How to use it

Take the JavaScript bundle at [targets/dist/happychat.js](./targets/dist/happychat.js) and embed it within your project. It'd expose the `Happychat` global variable:
Take the JavaScript bundle at [targets/browser/happychat.js](./targets/browser/happychat.js) and embed it within your project. It'd expose the `Happychat` global variable:

Happychat.open({
nodeId: '<HTML node ID where the UI will be rendered>',
Expand All @@ -20,8 +20,8 @@ Note that:

### Targets

Two integration targets are implemented in this repository:

Three integration targets are implemented in this repository:
- Browser: Happychat embeddedable library that exposes the Happychat API through browser's `window`.
- Standalone: Happychat embedded in a bare HTML page.
- WordPress: Happychat exposed as a shortcode in a WordPress environment.

Expand Down
8 changes: 7 additions & 1 deletion docs/HACKING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,16 @@

Topics discussed:

* Configs
* OAuth ID
* Repository layout
* The library renders within an iframe

## Configs
Config files are loaded based on the environment from the `src/config` directory. If you need to override
some of the values you can create a `development.local.json` that will be ignored by git.
See [src/config/README.md](./src/config/README.md) for more info.

## OAuth ID

The standalone target uses the `oauth_client_id` at [targets/standalone/config/index.js](./targets/standalone/config/index.js) to authenticate requests to WordPress.com.
Expand All @@ -21,7 +27,7 @@ The WordPress target doesn't need one because it's a plugin that runs within a W
- `state`: Redux state tree.
- `ui`: React components - these are unconnected to state.
- `targets`: apps that use the Happychat library
- `dist`: the production-ready JS and CSS assets.
- `browser`: the production-ready JS and CSS assets.
- `standalone`: bare HTML page with Happychat embedded.
- `wordpress`: WordPress plugin that exposes `happychat` as a shortcode.

Expand Down
22 changes: 0 additions & 22 deletions index.js
View file
Open in desktop

This file was deleted.

Loading