Skip to content

Commit

Permalink
Fix links to code in contributing.md (vercel#92)
Browse files Browse the repository at this point in the history
  • Loading branch information
styfle authored Jul 25, 2019
1 parent c06a2f5 commit c1360cc
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ There are two pieces to `og-image` that are worth noting before you begin develo
1. The backend image generator located in [/api/index.ts](https://github.com/zeit/og-image/blob/master/api/index.ts)
2. The frontend inputs located in [/web/index.ts](https://github.com/zeit/og-image/blob/master/web/index.ts)

The Now 2.0 platform handles [routing](https://github.com/zeit/og-image/blob/master/now.json#L9) in an elegate way for us so deployment is easy.
The Now 2.0 platform handles [routing](https://github.com/zeit/og-image/blob/master/now.json#L6) in an elegate way for us so deployment is easy.

To start hacking, do the following:

1. Clone this repo with `git clone https://github.com/zeit/og-image`
2. Change directory with `cd og-image`
3. Run `yarn` or `npm install` to install all dependencies
4. Run locally with `now dev` and visit [localhost:3000](http://localhost:3000) (if nothing happens, run `npm install -g now`)
5. If necessary, edit the `exePath` in [/api/options.ts](https://github.com/zeit/og-image/blob/master/api/options.ts) to point to your local Chrome executable
5. If necessary, edit the `exePath` in [options.ts](https://github.com/zeit/og-image/blob/master/api/_lib/options.ts) to point to your local Chrome executable

Now you're ready to start local development!

Expand Down

0 comments on commit c1360cc

Please sign in to comment.