diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..61acbb5 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,9 @@ +# Contributing + +We welcome template contributions that help demonstrate the full-stack capabilities of the Workers platform. If you're unsure about whether a template would be a good fit for this repository, feel free to open an issue with a link or description of your template idea to get feedback before writing up a pull request. + +We're especially interested in templates that use multiple binding or handler types together, such as [D1 databases](https://developers.cloudflare.com/d1/), [Workers AI](https://developers.cloudflare.com/workers-ai/), or [queue consumers](https://developers.cloudflare.com/queues/configuration/configure-queues/#consumer), just to name a few. + +## CI Checks + +Code formatting, linting, and all other checks are covered under the `check:ci` script. The `fix:ci` script will automatically fix as many of these issues as possible. If CI is failing on your pull request, running `npm run fix:ci` in the repository root may be able to fix all of your problems. diff --git a/README.md b/README.md index dc9c30d..1139279 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,33 @@ -# 🚧 Work in Progress 🚧 +# Templates for Cloudflare Workers -We're currently improving the Workers templates experience. +Cloudflare Workers let you deploy serverless code instantly across the globe for exceptional performance, reliability, and scale. This repository contains a collection of starter templates for building full-stack applications on Workers. **You are encouraged to use, modify, and extend this code!** + +## Getting Started + +There are two ways to start building with a template in this repository: the [Cloudflare dashboard](https://dash.cloudflare.com/) and [C3](https://developers.cloudflare.com/pages/get-started/c3/) (the `create-cloudflare` CLI). + +### Starting from the Dashboard + +After logging in or signing up through the [Cloudflare dashboard](https://dash.cloudflare.com/), open the [Workers templates page](https://dash.cloudflare.com/?to=/:account/workers-and-pages/templates) and select a template to get started with. From here, you can create a repository and deploy your first Worker without needing a local development environment. + +### Starting via CLI + +To get started locally, run one of the following commands: + +```bash +npm create cloudflare@latest +# or +pnpm create cloudflare@latest +# or +yarn create cloudflare@latest +``` + +For more information on getting started with our CLI, check out the [getting started guide](https://developers.cloudflare.com/workers/get-started/guide/). + +### Additional Resources + +Questions about Workers? Join the [official Cloudflare Discord](https://workers.community/) or check out the [Workers docs](https://developers.cloudflare.com/workers/)! + +## Contributing + +We welcome template contributions! If there's a Workers template you think would be valuable, please read our [contributing guide](./CONTRIBUTING.md) and open an issue or pull request.