https://github.com/spirit-js/spirit

Modern modular library for building web applications
https://github.com/spirit-js/spirit

functional http promise spirit web-framework

Last synced: 16 days ago
JSON representation

Modern modular library for building web applications

• Host: GitHub
• URL: https://github.com/spirit-js/spirit
• Owner: spirit-js
• License: isc
• Created: 2016-06-01T04:40:52.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2021-09-30T23:10:11.000Z (about 3 years ago)
• Last Synced: 2024-11-28T04:02:44.627Z (24 days ago)
• Topics: functional, http, promise, spirit, web-framework
• Language: JavaScript
• Homepage: http://spirit.function.run
• Size: 977 KB
• Stars: 244
• Watchers: 18
• Forks: 18
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# spirit

Modern and functional approach to building web applications.

[![Build Status](https://travis-ci.org/spirit-js/spirit.svg?branch=master)](https://travis-ci.org/spirit-js/spirit)

[![Coverage Status](https://coveralls.io/repos/github/spirit-js/spirit/badge.svg?branch=master)](https://coveralls.io/github/spirit-js/spirit?branch=master)

[![Join the chat at https://gitter.im/spirit-js/spirit](https://badges.gitter.im/spirit-js/spirit.svg)](https://gitter.im/spirit-js/spirit?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

## Why?

```js

const {adapter} = require("spirit").node

const route = require("spirit-router")

const http = require('http')

const hello = () => "Hello World!"

const greet = (name) => `Hello, ${name}`

const app = route.define([

  route.get("/", hello),

  route.get("/:name", ["name"], greet),

])

http.createServer(adapter(app)).listen(3000)

```

If we think about a web request in its simplest form, it's basically a function, it takes an input (request) and _returns_ an output (response). So why not write web applications this way?

No more `req`, `res`. Spirit simplifies everything by abstracting away the complexity of `req` and `res` that normally resulted in impure and complex functions.

Middleware in spirit can also transform the _returned_ response and not just the request. This is in contrast to other web libraries that can only transform the request. This is a simple idea but having this feature allows for much more DRY and expressive code.

Given the above, it's much more easier to re-use, test, and reason about your code in spirit.

Oh yea, most [Express middleware works in spirit](https://github.com/spirit-js/spirit-express) too!

## Getting Started

[The Handbook](http://spirit.function.run/)

- [collection of Examples](https://github.com/spirit-js/examples)

- [spirit API Docs](docs/api)

- [spirit + spirit-router Guide](https://github.com/spirit-js/spirit-router/tree/master/docs/Guide.md)

- [Introduction Video](https://www.youtube.com/watch?v=YvxLBd12ZX8&list=PLHw25bReXDKvHd-5mCjMxVkgDvWrx5IFY)

### Components

- `spirit` is a small library for composing functions and creating abstractions. Abstractions are defined in a "spirit adapter". Currently it comes with 1 builtin, the node adapter (`spirit.node`) for use with node.js' http module. Eventually there will be another one written for spirit to run in the browser.

- [`spirit-router`](https://github.com/spirit-js/spirit-router) is a library for routing and creating routes.

- [`spirit-common`](https://github.com/spirit-js/spirit-common) is a library that provides many common http related middleware. It's purpose is to make bootstrapping a multitude of middleware that everyone will need easier.

- [`spirit-express`](https://github.com/spirit-js/spirit-express), is a library for converting most Express middleware to work in spirit.

### Third Party Components

- [`spirit-body`](https://github.com/dodekeract/spirit-body) is a simple body parser middleware for spirit. Alternative to using `spirit-common` which wraps the Express body-parser module.

## Contributing

All contributions are appreciated and welcomed.

For backwards incompatible changes, or large changes, it would be best if you opened an issue before hand to outline your plans (to avoid conflict later on).

This codebase avoids using unnecessary semi-colons, camelCase and one-liners.

To run tests, use `make test`. This will also build changes to `src/*`, if you do not have `make` installed, you can look at the [Makefile](/Makefile) to see the steps to accomplish the task.

## Credits

Spirit is heavily influenced by the design of [Ring](https://github.com/ring-clojure/ring).