Skip to content

Commit

Permalink
Move to zeit org (vercel#67)
Browse files Browse the repository at this point in the history
* Move to zeit org

* Remove author, use yarn

* Add .yarnrc so dependencies lock

* Save exact dependencies
  • Loading branch information
styfle authored Mar 4, 2019
1 parent 9762ae2 commit 13a95a4
Show file tree
Hide file tree
Showing 8 changed files with 347 additions and 385 deletions.
1 change: 1 addition & 0 deletions .yarnrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
save-prefix ""
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

There are two pieces to `og-image` that are worth noting before you begin development.

1. The backend image generator located in [/src/card.ts](https://github.com/styfle/og-image/blob/master/src/card.ts)
2. The frontend inputs located in [/src/browser.ts](https://github.com/styfle/og-image/blob/master/src/browser.ts)
1. The backend image generator located in [/src/card.ts](https://github.com/zeit/og-image/blob/master/src/card.ts)
2. The frontend inputs located in [/src/browser.ts](https://github.com/zeit/og-image/blob/master/src/browser.ts)

The Now 2.0 platform handles [routing](https://github.com/styfle/og-image/blob/master/now.json#L12) 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#L12) in an elegate way for us so deployment is easy.

However, local development requires a few steps.

Expand All @@ -14,6 +14,6 @@ However, local development requires a few steps.
3. Run `npm run watch` to get TS to JS compilation file watch running (compiles on save)
4. Run the backend with `npm start` (you can try it by visiting http://localhost:13463/Nice.png)
5. Run the frontend with `npx http-server .` and visit http://localhost:8080/public/index.html
6. If necessary, edit the `exePath` in [options.ts](https://github.com/styfle/og-image/blob/master/src/options.ts) to point to your local Chrome executable
6. If necessary, edit the `exePath` in [options.ts](https://github.com/zeit/og-image/blob/master/src/options.ts) to point to your local Chrome executable

Now you're ready to start local development!
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# [Open Graph Image as a Service](https://og-image.now.sh)

<a href="https://twitter.com/zeithq/status/1092587111985881088">
<img align="right" src="https://raw.githubusercontent.com/styfle/og-image/master/public/tweet.png" height="300" />
<img align="right" src="https://raw.githubusercontent.com/zeit/og-image/master/public/tweet.png" height="300" />
</a>

Serverless service that generates dynamic Open Graph images that you can embed in your `<meta>` tags.
Expand Down Expand Up @@ -51,12 +51,12 @@ You'll want to fork this repository and deploy your own image generator.

1. Click the fork button at the top right of GitHub
2. Clone the repo to your local machine with `git clone URL_OF_FORKED_REPO_HERE`
3. Make changes by swapping out images, changing colors, etc (see [contributing](https://github.com/styfle/og-image/blob/master/CONTRIBUTING.md) for more)
3. Make changes by swapping out images, changing colors, etc (see [contributing](https://github.com/zeit/og-image/blob/master/CONTRIBUTING.md) for more)
4. Deploy by running `now` from the CLI (if you don't already have it, run `npm install -g now`)

Alternatively, you can do a one-click to deploy with the button below.

[![Deploy to now](https://deploy.now.sh/static/button.svg)](https://deploy.now.sh/?repo=https://github.com/styfle/og-image)
[![Deploy to now](https://deploy.now.sh/static/button.svg)](https://deploy.now.sh/?repo=https://github.com/zeit/og-image)

Once you have an image generator that sparks joy, you can setup [automatic Now + GitHub](https://zeit.co/github) deployments so that pushing to master is also deploying to production! 🚀

Expand Down
2 changes: 1 addition & 1 deletion now.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "og-image",
"alias": "og-image.now.sh",
"alias": ["api-og-image.zeit.sh"],
"version": 2,
"regions": ["all"],
"public": true,
Expand Down
Loading

0 comments on commit 13a95a4

Please sign in to comment.