/deno-rest-api

An example REST API implementation for Deno using Oak framework

Primary LanguageTypeScriptMIT LicenseMIT

Codacy Badge Codebeat Badge CodeFactor Badge DeepScan grade Analytics

Deno REST API

A simple REST API starter kit implementation in Deno environment using OAK as middleware framework.

The app contains basics CRUD operations managing a Book entity using at the moment a simple Interface for modeling the REST Entity with read and write operation in an array collection.

Visitor stats

GitHub stars GitHub forks GitHub watchers GitHub followers

Code stats

GitHub code size in bytes GitHub repo size GitHub language count GitHub top language GitHub last commit

TODO: Add database and authentication support.

Prerequisites

  1. Install Deno

Shell (Mac, Linux):

curl -fsSL https://deno.land/x/install/install.sh | sh

PowerShell (Windows):

iwr https://deno.land/x/install/install.ps1 -useb | iex

Homebrew (Mac):

brew install deno

Chocolatey (Windows):

choco install deno

Scoop (Windows):

scoop install deno

Build and install from source using Cargo

cargo install deno
  1. Configure your IDE. I am using VSCode so I installed the official Deno extension from the Visual Studio Marketplace. Then I followed the setup instructions:

Usage

Lint using Deno's built in linter

./scripts/lint.sh

Format using Deno's built in formatter

./scripts/format.sh

Start your server on port 5000

./scripts/run.sh

Compile into a single executable

./scripts/compile.sh

LICENSE

MIT

Connect with me:

                     
Support and sponsor my work: