Skip to content
This repository has been archived by the owner on Mar 29, 2024. It is now read-only.

Commit

Permalink
update generated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mnutt committed Feb 16, 2018
1 parent 9476a56 commit 150d4ef
Showing 1 changed file with 17 additions and 8 deletions.
25 changes: 17 additions & 8 deletions blueprints/app/files/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,22 +11,31 @@ You will need the following things properly installed on your computer.
* [Node.js](https://nodejs.org/)
* [Yarn](https://yarnpkg.com/)

## Updating in dev
## Developing

First, you need to have the `push-dev-cartridge` script. You can get it like so:
First, ensure that you have the latest version of the MDK. Get it via:

```
curl 'https://movableink-chef.s3.amazonaws.com/local-tools/push-dev-cartridge' > /usr/local/bin/push-dev-cartridge
chmod +x /usr/local/bin/push-dev-cartridge
yarn global add @movable/cli
```

(don't blindly download scripts, take a glance through it)
Then you can start the UI via `movable serve` then navigate your browser to http://localhost:4200 to view the UI.

Then, you can push locally by running `push-dev-cartridge` from this directory. This will do two things:
You can run tests using `yarn test`.

## Deploying to a local environment

If you're running the Movable Ink platform locally, you can deploy to that with:

```
movable deploy development
```

* Uploads the directory to `movableink-cartridge-development` s3 bucket.
* Posts to your local rails server to register the updated cartridge.

This also requires the `s3cmd` tool and the relevant s3 credentials.

## Deploying to production

You need to run a one-time setup to add gitolite as a remote:
Expand All @@ -38,7 +47,7 @@ bin/setup-deploy
Then you can deploy:

```
git deploy-production
movable deploy production
```

This deploys your `master` branch to git.movableink.com and is the recommended deploy method.
This deploys your current branch to git.movableink.com and is the recommended deploy method.

0 comments on commit 150d4ef

Please sign in to comment.