blockworks-foundation
/
og-image
mirror of https://github.com/blockworks-foundation/og-image.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Rename master to main

This commit is contained in:
Steven 2020-08-11 15:53:00 -04:00
parent 8026662bcc
commit bb67bdd5bd
2 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
CONTRIBUTING.md
View File

@ -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 [/api/index.ts](https://github.com/vercel/og-image/blob/master/api/index.ts)
2. The frontend inputs located in [/web/index.ts](https://github.com/vercel/og-image/blob/master/web/index.ts)
1. The backend image generator located in [/api/index.ts](https://github.com/vercel/og-image/blob/main/api/index.ts)
2. The frontend inputs located in [/web/index.ts](https://github.com/vercel/og-image/blob/main/web/index.ts)
Vercel handles [routing](https://github.com/vercel/og-image/blob/master/vercel.json#L6) in an elegate way for us so deployment is easy.
Vercel handles [routing](https://github.com/vercel/og-image/blob/main/vercel.json#L6) in an elegate way for us so deployment is easy.
To start hacking, do the following:
@ -13,7 +13,7 @@ To start hacking, do the following:
2. Change directory with `cd og-image`
3. Run `yarn` or `npm install` to install all dependencies
4. Run locally with `vercel dev` and visit [localhost:3000](http://localhost:3000) (if nothing happens, run `npm install -g vercel`)
5. If necessary, edit the `exePath` in [options.ts](https://github.com/vercel/og-image/blob/master/api/_lib/options.ts) to point to your local Chrome executable
5. If necessary, edit the `exePath` in [options.ts](https://github.com/vercel/og-image/blob/main/api/_lib/options.ts) to point to your local Chrome executable
Now you're ready to start local development!

2
README.md
View File

@ -54,7 +54,7 @@ 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. Change directory with `cd og-image`
4. Make changes by swapping out images, changing colors, etc (see [contributing](https://github.com/vercel/og-image/blob/master/CONTRIBUTING.md) for more info)
4. Make changes by swapping out images, changing colors, etc (see [contributing](https://github.com/vercel/og-image/blob/main/CONTRIBUTING.md) for more info)
5. Hobby plan users will need to remove all configuration inside `vercel.json` besides `rewrites`
6. Run locally with `vercel dev` and visit [localhost:3000](http://localhost:3000) (if nothing happens, run `npm install -g vercel`)
7. Deploy to the cloud by running `vercel` and you'll get a unique URL