Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ravendb/template-cloudflare-worker

A batteries included template for kick starting a TypeScript Cloudflare worker project that connects with a RavenDB Cloud database backend.
https://github.com/ravendb/template-cloudflare-worker

cloudflare cloudflare-workers ravendb typescript

Last synced: 19 days ago
JSON representation

A batteries included template for kick starting a TypeScript Cloudflare worker project that connects with a RavenDB Cloud database backend.

Awesome Lists containing this project

README 

        
# RavenDB Cloudflare Worker Template (TypeScript)



[![Deploy to Cloudflare Workers](https://deploy.workers.cloudflare.com/button)](https://deploy.workers.cloudflare.com/?url=https://github.com/ravendb/template-cloudflare-worker) [![Open on StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)][stackblitz]



A batteries included template for kick starting a TypeScript Cloudflare worker project that connects to a hosted RavenDB database.



[RavenDB][cloud-signup] is a NoSQL document database for distributed applications offering industry-leading security without compromising performance. With a RavenDB database you can set up a NoSQL data architecture or add a NoSQL layer to your current relational database.



> The easiest way to get started with RavenDB is by creating [a free RavenDB Cloud account][cloud-signup] or requesting a free license to [download it yourself][download].

>

> If you are _brand new_ to RavenDB, we recommend starting with the [Getting Started guide][docs-get-started], the [RavenDB bootcamp][learn-bootcamp], or the [Try RavenDB][learn-demo] experience.



## How to Use This Template



To create a `my-project` directory using this template, run:



```sh

$ npm init cloudflare my-project https://github.com/ravendb/template-cloudflare-worker

# or

$ yarn create cloudflare my-project https://github.com/ravendb/template-cloudflare-worker

# or

$ pnpm create cloudflare my-project https://github.com/ravendb/template-cloudflare-worker

```



> **Note:** Each command invokes [`create-cloudflare`](https://www.npmjs.com/package/create-cloudflare) for project creation.



To start the worker:



```sh

$ npm start

```



### Configure the Template



Read through [the step-by-step guide in the RavenDB docs][docs-howto] that covers how to get up and running successfully with this template by configuring the worker to use mTLS certificates.



### Wrangler Environment Variables



In `wrangler.toml`:



- `DB_URLS`: Comma-separated values for your RavenDB cluster node URLs

- `DB_NAME`: Database to connect to. **Warning:** Ensure the database exists otherwise you will receive a `DatabaseNotFoundException`.



These will automatically be set during deployment and will override any settings in the Cloudflare dashboard.



### Deploying to Cloudflare



You can manually deploy through the Wrangler CLI using `wrangler deploy` but the template is automatically configured for CI/CD using GitHub Actions workflows. You will need the following secrets:



- `CF_API_TOKEN` -- The API token secret for your deployment. Requires access to workers.

- `CF_ACCOUNT_ID` -- Your global Cloudflare account ID



These are set automatically if using the Cloudflare Worker Deployment wizard.



### mTLS Certificates



Obtain your RavenDB client certificate from the Cloud dashboard, Manage Server > Certificates in the Studio, or the Raven Admin CLI. You will need the `.crt` (public key) and `.key` (private key) files.



Upload the mTLS certificate using `wrangler`:



```sh

$ npx wrangler mtls-certificate upload --cert cert.crt --key key.key --name cert_name

```



This will output your `` to use in your `wrangler.toml` file for the `DB_CERT` binding. See the [Cloudflare mTLS for Workers][cf-workers-mtls] documentation for more.



[stackblitz]: https://stackblitz.com/github/ravendb/template-cloudflare-worker

[cloud-signup]: https://cloud.ravendb.net?utm_source=github&utm_medium=web&utm_campaign=github_template_cloudflare_worker&utm_content=cloud_signup

[download]: https://ravendb.net/download?utm_source=github&utm_medium=web&utm_campaign=github_template_cloudflare_worker&utm_content=download

[docs-get-started]: https://ravendb.net/docs/article-page/csharp/start/getting-started?utm_source=github&utm_medium=web&utm_campaign=github_template_cloudflare_worker&utm_content=docs_get_started

[docs-create-db]: https://ravendb.net/docs/article-page/csharp/studio/database/create-new-database/general-flow?utm_source=github&utm_medium=web&utm_campaign=github_template_cloudflare_worker&utm_content=docs_new_db

[learn-bootcamp]: https://ravendb.net/learn/bootcamp?utm_source=github&utm_medium=web&utm_campaign=github_template_cloudflare_worker&utm_content=learn_bootcamp

[learn-demo]: https://demo.ravendb.net/?utm_source=github&utm_medium=web&utm_campaign=github_template_cloudflare_worker&utm_content=learn_demo

[docs-howto]: https://ravendb.net/docs/article-page/nodejs/getting-started/guides/cloudflare-workers/overview?utm_source=github&utm_medium=web&utm_campaign=github_template_cloudflare_worker&utm_content=docs_howto

[docs-howto-video]: #tbd

[cf-workers-mtls]: https://developers.cloudflare.com/workers/runtime-apis/mtls/