Skip to content

Commit

Permalink
Update the setup docs
Browse files Browse the repository at this point in the history
  • Loading branch information
orta committed Aug 25, 2018
1 parent 4f9ce08 commit f7046a1
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 71 deletions.
1 change: 1 addition & 0 deletions Brewfile
@@ -0,0 +1 @@
brew "memcached"
26 changes: 19 additions & 7 deletions README.md
Expand Up @@ -43,25 +43,35 @@ It is currently used in production all over the place in

### Getting Setup

Read and run setup script:
To get yourself set up with all the project's dependencies:

```
$ cat bin/setup
$ bin/setup
git clone https://github.com/artsy/metaphysics
cd metaphysics
# Install node modules
yarn install
# Installed system tools (like cache servers)
brew bundle
# Get set up with a default env
cp .env.example .env
```

Set up your `.env` file based on `.env.example`. For Artsy staff, grab the
keys/secrets from 1Password.
For Artsy staff wanting to expand on your `.env`, you can use `hokusai staging env get` to see staging's env vars.

### Development

To start up a development server, run:
With your dependencies set up, you can run Metaphysics by running:

```sh
yarn install
yarn dev
```

Which will start the server on http://localhost:5001

_Recommended:_ You can run the commands inside the terminal in VS Code, then the debugger will be hooked up
by default.

### Setting up your local GraphiQL

We recommend the [graphiql.app](https://github.com/skevy/graphiql-app) client
Expand All @@ -81,6 +91,8 @@ You will need to set up headers with both:

### Docker and Kubernetes setup

This is deployed using Hokusai to manage Docker and Kubernetes. To replicate this:

- Install [Docker for Mac](https://github.com/artsy/hokusai#requirements) and
[Hokusai](https://github.com/artsy/hokusai#setup)

Expand Down
57 changes: 0 additions & 57 deletions bin/setup

This file was deleted.

8 changes: 1 addition & 7 deletions docs/debugging_with_vscode.md
Expand Up @@ -2,15 +2,9 @@

If you want an overview of how VS Code differs from traditional TextMate clones, read Orta's [post on the Artsy blog](http://artsy.github.io/blog/2016/08/15/vscode/).

## Types

We get partial typing by default through Flow, and the graphql module by default.

To get more extensive typing you need to install [flow-typed](https://github.com/flowtype/flow-typed), via `yarn global add flow-typed`. Then run `flow-typed install` in the root directory.

## Running Metaphysics

You can _optionally_ run Metaphysics inside your editor, this is done via the task "Start Node Foreman in Dev". To run it trigger "Build Mode" in VS Code (defaults to `cmd + shift + b`.) To close the server, either close the window - or run the command "Tasks: Terminate running tasks".
Ideally you should run Metaphysics

## Debugging Metaphysics

Expand Down

0 comments on commit f7046a1

Please sign in to comment.