gabrielgrover / deno-drash

A REST microframework for Deno's HTTP server with zero dependencies.

Drash

A REST microframework for Deno's HTTP server with zero dependencies.

---

Table of Contents

• Quick Start
• Create Drash App
• Documentation
• Features
• Why use Drash?
• Contributing
• License

Quick Start

// File: app.ts

import { Drash } from "https://deno.land/x/[email protected]/mod.ts";

class HomeResource extends Drash.Http.Resource {
  static paths = ["/"];
  public GET() {
    this.response.body = "Hello World! deno + Drash is cool!";
    return this.response;
  }
}

const server = new Drash.Http.Server({
  response_output: "text/html",
  resources: [HomeResource]
});

server.run({
  hostname: "localhost",
  port: 1447
});

console.log("Server listening: http://localhost:1447");

$ deno run --allow-net app.ts
Server listening: http://localhost:1447

$ curl localhost:1447
Hello World! deno + Drash is cool!

Create Drash App

Drash provides a basic tool to help you quickly create a Drash skeleton, with everything working out of the box, ready for you to build something great with.

This tool does not require you to install any Drash scripts or modules. It will create the skeleton of your choice (an API, a full web app, or a full web app with Vue) inside your current working directory.

To get started with the Create Drash App tool, see the following commands:

$ mkdir my-drash-project
$ cd my-drash-project

• To make an API:

  $ deno run --allow-run --allow-read --allow-write --allow-net https://deno.land/x/drash/create_app.ts --api
  

• To make a web app:

  $ deno run --allow-run --allow-read --allow-write --allow-net https://deno.land/x/drash/create_app.ts --web-app
  

• To make a web app with Vue:

  $ deno run --allow-run --allow-read --allow-write --allow-net https://deno.land/x/drash/create_app.ts --web-app --with-vue
  

Display the options with --help:

$ deno run --allow-run --allow-read https://deno.land/x/drash/create_app.ts --help

Documentation

Full Documentation

Lifecycle Diagram

Features

• Content Negotiation
• Static Path Routing
• Regex Path Routing
• Middleware
• Body Handling: application/json
• Body Handling: application/x-www-form-urlencoded
• Body Handling: multipart/form-data
• Handling Path Params
• Handling URL Query Params
• Console Logging
• File Logging

Why Use Drash?

Drash is designed to help you build your projects quickly with the ability to scale. You can build an API, a web app, an SPA (like the documentation pages), or even a static HTML site. How you use Drash is up to you, so it can be everything you need and nothing you don't — like a DRASH tent.

Drash takes concepts from the following:

• Flask — being micro and extensible
• Laravel — use of similarly styled middleware
• Tonic — use of resources
• RESTful principles — content negotiation, HTTP verbs, URIs, etc.

Thrown into the mix is Drash's own concepts such as:

• Documentation-driven development
• Test-driven development
• Lowering barriers to usage

Drash does not force you to use all of its code. You can pick and choose which data members you want/need and use them however you deem fit. For example, Drash comes with a console logger and a file logger. If you only want these, then you only import these into your non-Drash project. How you use it is really up to you.

Contributing

Contributors are welcomed!

Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.

License

By contributing your code, you agree to license your contribution under the MIT License.