# firestone

> work in progress

Latest version **0.1.1** (published 2016-01-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install firestone
pnpm add firestone
yarn add firestone
bun add firestone
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2016-01-02 |
| First published | 2015-12-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 (+2 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Martin Imfeld |
| Maintainers | martianfield |

## Links

- npm: https://www.npmjs.com/package/firestone
- Repository: https://github.com/martianfield/firestone
- Homepage: https://github.com/martianfield/firestone#readme
- Issues: https://github.com/martianfield/firestone/issues
- npm.io page: https://npm.io/package/firestone

## Dependencies (4)

- [express](https://npm.io/package/express.md) ^4.13.3
- [mongodb](https://npm.io/package/mongodb.md) ^2.1.2
- [kerberos](https://npm.io/package/kerberos.md) 0.0.17
- [body-parser](https://npm.io/package/body-parser.md) ^1.14.2

## Recent versions

- 0.1.1 (latest) — 2016-01-02
- 0.1.0 — 2015-12-25

## README

# Firestone

A thin REST API prototyping framework using Express and MongoDB.

**NOTE: EVERYTHING HERE IS IN ALPHA. THINGS ARE IN CONSTANT FLUX AND VERY MUCH INCOMPLETE.**

Note: Yes, I  am probably re-inventing the wheel here. There are other (better) solutions like FeathersJs ... have a look there.

Quickly create RESTful APIs using Node, Express, and Mongo.

## Quickstart

In its most basic form, a Firestone app looks like this:

```javascript
'use strict';
const firestone = require('firestone');

// define routes
const routes = [
	{
		path: '/doctors',
		collection: 'doctors',
		map: firestone.mapMaker({actor:String}, {fez:Boolean})
	}
]

// configure firestone
firestone.config('mongoUri', 'mongodb://localhost:27017/firestone_example');
firestone.config('routes', routes);

// create express app and use routes
const app = require('express')();
app.use(firestone.routeMaker());

// serve the express app
const port = process.env.PORT || 3000;
app.listen(port);
console.log(`serving at http://localhost:${port}`);
```

---
_Source: https://npm.io/package/firestone · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._