0.0.1 • Published 7 years ago

ambassador-app v0.0.1

Weekly downloads
6
License
-
Repository
github
Last release
7 years ago

Ambassador App

Ambassador App is a React/Redux app for companies to manage their referral programs and NPS surveys.

Getting the app running

1) Clone the ambassador-app repo:

$ git clone git@github.com:GetAmbassador/ambassador-app.git

2) Move into the project:

$ cd ambassador-app

3) Symlink the Git hooks:

$ ln -s ../../git-hooks/prepare-commit-msg .git/hooks/prepare-commit-msg
$ ln -s ../../git-hooks/pre-push .git/hooks/pre-push

4) The pre-push hook requires re-initialization of the repo:

$ git init

5) Make sure the pre-push hook is executable:

$ chmod +x .git/hooks/pre-push

6) Set up NPM authentication

Run npm login and log in as “ambassador” (you can see the credentials in Meldium).

Open your ~/.npmrc file in any editor - you should see something like this:

//registry.npmjs.org/:_authToken=00000000-0000-0000-0000-000000000000

Open your ~/.profile (or ~/.zprofile in you are using zsh) file in any editor and add the following line:

export NPM_TOKEN="00000000-0000-0000-0000-000000000000"

Replace the 00000000-... with the token from your ~/.npmrc file then save.

Finally, refresh your environment variables: source ~/.profile

7) Set environment variables

Make a copy of the sample environment:

$ cp sample.env .env

And populate with any of the following environment variables:

- NODE_ENV - This will be set to `development` or `production`.
- API_URL - The hostname of the Ambassador API you wish to use. For local dev use `https://dev-ambassador-api.herokuapp.com`.
- SNIPPET_URL - The hostname of the Ambassador Snippet you wish to use. For local dev use `https://dev-cdn.getambasssador.com`.
- APP_URL - The hostname of the Ambassador App you wish to use. For local dev use `https://dev-app.getambassador.com`.

8) Install node packages:

$ npm install

9) Run the app:

$ npm start

Point your browser to http://localhost:3000

Testing

Coming soon.