README.md

RavenDB Templates

RavenDB 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 or requesting a free license to download it yourself.

If you are brand new to RavenDB, we recommend starting with the Getting Started guide, the RavenDB bootcamp, or the Try RavenDB experience.

Get started quickly with RavenDB using different framework and service integrations.

Template	Deploy	Watch Tutorial	Clone Template Command
AWS Lambda .NET (C#)			Clone Command (npx): npx degit ravendb/templates/aws-lambda/csharp-http my-project; cd my-project; git init Clone Command (Bash): git clone https://github.com/ravendb/templates my-project; cd my-project; git filter-branch --subdirectory-filter aws-lambda/csharp-http; rm -rf .git; git init Clone Command (Powershell): git clone https://github.com/ravendb/templates my-project; cd my-project; git filter-branch --subdirectory-filter aws-lambda/csharp-http; rm -r -force .git; git init
Azure Functions .NET (C#)			Clone Command (npx): npx degit ravendb/templates/azure-functions/csharp-http my-project; cd my-project; git init Clone Command (Bash): git clone https://github.com/ravendb/templates my-project; cd my-project; git filter-branch --subdirectory-filter azure-functions/csharp-http; rm -rf .git; git init Clone Command (Powershell): git clone https://github.com/ravendb/templates my-project; cd my-project; git filter-branch --subdirectory-filter azure-functions/csharp-http; rm -r -force .git; git init
Azure Functions Node.js (TypeScript)			Clone Command (npx): npx degit ravendb/templates/azure-functions/node-http my-project; cd my-project; git init Clone Command (Bash): git clone https://github.com/ravendb/templates my-project; cd my-project; git filter-branch --subdirectory-filter azure-functions/node-http; rm -rf .git; git init Clone Command (Powershell): git clone https://github.com/ravendb/templates my-project; cd my-project; git filter-branch --subdirectory-filter azure-functions/node-http; rm -r -force .git; git init
Cloudflare Worker (TypeScript)			Clone Command (npx): npx degit ravendb/template-cloudflare-worker my-project; cd my-project; git init Clone Command: git clone https://github.com/ravendb/template-cloudflare-worker my-project; cd my-project; git init

Cloning the Templates

If you don't want to use a deployment wizard or need to clone the templates locally, here are two ways:

If you have Node.js and npx installed:

You can use degit to quickly scaffold a template:

npx degit ravendb/templates/<template_dir> [new_repo_name]

For example:

$ npx degit ravendb/templates/azure-functions/node-http my-project
$ cd my-project
$ git init

If the project directory is omitted, the template will be cloned in the current directory.

Manually using git

This is more involved but has 3 steps:

1. Clone the repository into a new folder
2. Filter the subtree to only the subdirectory of the template
3. Reset Git

The commands to do this are:

$ git clone git clone https://github.com/ravendb/templates <new_repo_name>
$ git filter-branch --subdirectory-filter <template_dir>
$ rm -rf .git # or `rm -r -force .git` on Windows
$ git init

Above in the table there is a clone command box you can copy from and paste directly into the terminal that concatenates these into one command sequence.

Configure the Templates

You can find detailed how-to guides and videos on the RavenDB docs for each template.