Add creative commons configuration files and metadata

Author: zackkrida

.cc-metadata.yml

@@ -0,0 +1,10 @@
+# Whether this GitHub repo is engineering related
+engineering_project: true
+# Name of the repository/project in English
+english_name: CC Open Graph Image Generator
+# All technologies used
+technologies: JavaScript
+# Whether this repository should be featured on the CC Open Source site
+featured: false
+# Slack channel name
+slack: "cc-developers"

.editorconfig

@@ -0,0 +1,8 @@
+root = true
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true

.prettierrc.js

@@ -0,0 +1,6 @@
+module.exports = {
+  trailingComma: "es5",
+  tabWidth: 2,
+  semi: false,
+  singleQuote: true,
+};

.vercelignore

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+The Creative Commons team is committed to fostering a welcoming community. This
+project and all other Creative Commons open source projects are governed by our
+[Code of Conduct][code_of_conduct]. Please report unacceptable behavior to
+[conduct@creativecommons.org](mailto:conduct@creativecommons.org) per our
+[reporting guidelines][reporting_guide].
+
+For a history of updates, see the [page history here][updates].
+
+[code_of_conduct]: https://opensource.creativecommons.org/community/code-of-conduct/
+[reporting_guide]: https://opensource.creativecommons.org/community/code-of-conduct/enforcement/
+[updates]: https://github.com/creativecommons/creativecommons.github.io-source/commits/master/content/community/code-of-conduct/contents.lr

CODE_OF_CONDUCT.md

@@ -1,20 +1,47 @@
-# Contributing
+# Contributing to CC Open Source
 
-There are two pieces to `og-image` that are worth noting before you begin development.
+Thank you for your interest in contributing to CC Open Source! This document is a set of guidelines to help you contribute to this project.
 
-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)
+## Code of Conduct
 
-Vercel handles [routing](https://github.com/vercel/og-image/blob/main/vercel.json#L6) in an elegate way for us so deployment is easy.
+By participating in this project, you are expected to uphold our [Code of Conduct](https://opensource.creativecommons.org/community/code-of-conduct/).
 
-To start hacking, do the following:
+## Project Documentation
 
-1. Clone this repo with `git clone https://github.com/vercel/og-image`
-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/main/api/_lib/options.ts) to point to your local Chrome executable
+Please consult the [README](./README.md) and [CODEBASE](./CODEBASE.md) files at the root of this repository.
 
-Now you're ready to start local development!
+## How to Contribute
 
-You can set an environment variable to assist with debugging `export OG_HTML_DEBUG=1`. This will render the image as HTML so you can play around with your browser's dev tools before committing changes to the template.
+Please read the processes in our general [Contributing Code](https://opensource.creativecommons.org/contributing-code/) guidelines on the Creative Common Open Source website. It contains some general instructions that should be followed when contributing to any of the Creative Commons open-source repositories.
+
+### Bugs
+
+If you find a bug, please open an issue in this repository describing the bug. You can file a bug [here](https://github.com/creativecommons/og-image-generator/issues/new?template=bug_report.md). You will see a bug report template with the required information you should provide.
+
+After that, don't forget to tag the issue with the "Bug" label.
+
+### Proposing changes or new features
+
+If you have an idea of a new feature or change to how the CC Search frontend works, please [file an issue](https://github.com/creativecommons/og-image-generator/issues/new?template=feature_request.md) so we can discuss the possibility of that change or new feature being implemented and released in the future. This lets us come to an agreement about the proposed idea before any work is done.
+
+If you'd like to build a new feature but don't have a specific idea, please check our [public roadmap](https://docs.google.com/document/d/19yH2V5K4nzWgEXaZhkzD1egzrRayyDdxlzxZOTCm_pc/). Choose something from the pipeline of ideas and follow the same process as above.
+
+### Pull requests
+
+Before you start writing code, make sure there is an issue open. Pull requests without a link to an existing issue won't be merged. All pull requests _must_ target the `develop` branch of the repository.
+
+If you want to get started contributing code to this project but don't know exactly what to work on, we compiled a good list of issues labeled as [Good first issues](https://github.com/creativecommons/og-image-generator/labels/good%20first%20issue) which are small in scope and not so complex to solve. There is also issues labeld as [Help wanted](https://github.com/creativecommons/og-image-generator/labels/help%20wanted) which can be a bit more complex but are good examples of thigns we are currently accepting help from the community.
+
+Any code modifications will have to be accompanied by the appropriate unit tests. This will be checked and verified during code review. Once the Pull Reques is opened, our CI server will run the unit test suite and run a code linter to verify that the code follows the coding guidelines.
+
+If you want to run the unit tests and linter on your machine, run the following commands:
+
+`npm run unit` for unit tests
+
+`npm run lint` for linter.
+
+You can also configure your editor of choice with a ESLint plugin so you can get the linter feedback as you write code.
+
+## Questions or Thoughts?
+
+Talk to us on [our developer mailing list or Slack community](https://opensource.creativecommons.org/community/).

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019-2020 Vercel, Inc.
+Copyright (c) 2020 Creative Commons
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

LICENSE

@@ -1,18 +1,9 @@
-<a href="https://vercel.com/new/project?template=vercel/og-image"><img width="128" src="https://vercel.com/button" align="right"></a>
-
-# [Open Graph Image as a Service](https://og-image.vercel.app)
-
-<a href="https://twitter.com/vercel">
-    <img align="right" src="https://og-image.vercel.app/tweet.png" height="300" />
-</a>
+# Open Graph Image Generator
 
 Serverless service that generates dynamic Open Graph images that you can embed in your `<meta>` tags.
 
 For each keystroke, headless chromium is used to render an HTML page and take a screenshot of the result which gets cached.
 
-See the image embedded in the tweet for a real use case.
-
-
 ## What is an Open Graph Image?
 
 Have you ever posted a hyperlink to Twitter, Facebook, or Slack and seen an image popup?
@@ -32,16 +23,19 @@ It looks like the following:
 
 ## Why use this service?
 
-The short answer is that it would take a long time to painstakingly design an image for every single blog post and every single documentation page. And we don't want the exact same image for every blog post because that wouldn't make the article stand out when it was shared to Twitter. 
+The short answer is that it would take a long time to painstakingly design an image for every single blog post and every single documentation page. And we don't want the exact same image for every blog post because that wouldn't make the article stand out when it was shared to Twitter.
 
-That's where `og-image.vercel.app` comes in. We can simply pass the title of our blog post to our generator service and it will generate the image for us on the fly!
+That's where `cc-og-image.vercel.app` comes in. We can simply pass the title of our blog post to our generator service and it will generate the image for us on the fly!
 
 It looks like the following:
 
 ```html
 <head>
   <title>Hello World</title>
-  <meta property="og:image" content="https://og-image.vercel.app/Hello%20World.png" />
+  <meta
+    property="og:image"
+    content="https://cc-og-image.vercel.app/Hello%20World.png"
+  />
 </head>
 ```
 
@@ -56,7 +50,7 @@ You'll want to fork this repository and deploy your own image generator.
 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/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`)
+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
 8. Setup [GitHub](https://vercel.com/github) to autodeploy on push
 
@@ -66,7 +60,6 @@ If you are using a paid plan, you can do a one-click deploy with the button belo
 
 Once you have an image generator that sparks joy, you can setup [automatic GitHub](https://vercel.com/github) deployments so that pushing to master will deploy to production! 🚀
 
-## Authors
+## Credits
 
-- Steven ([@styfle](https://twitter.com/styfle)) - [Vercel](https://vercel.com)
-- Evil Rabbit ([@evilrabbit](https://twitter.com/evilrabbit_)) - [Vercel](https://vercel.com)
+This is based on the lovely [Open Graph Image Generator](https://github.com/vercel/og-image) created by [Vercel](https:/vercel.com). They