Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jerryjappinen/scam
Simple schema-based REST API on node and SQLite. Prototype full CRUD flows in 5 minutes.
https://github.com/jerryjappinen/scam
Last synced: 2 months ago
JSON representation
Simple schema-based REST API on node and SQLite. Prototype full CRUD flows in 5 minutes.
- Host: GitHub
- URL: https://github.com/jerryjappinen/scam
- Owner: jerryjappinen
- Created: 2017-07-19T07:39:56.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-07-26T17:26:48.000Z (over 7 years ago)
- Last Synced: 2024-04-24T16:24:28.733Z (9 months ago)
- Language: JavaScript
- Homepage:
- Size: 268 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Scam
Simple schema-based REST API on node and SQLite, with fully functional CRUD flows.
- Source: https://github.com/Eiskis/scam
- Demo project: https://github.com/Eiskis/scam-demo
- Demo project deployed to Heroku: https://scam-demo.herokuapp.com/
**Scam is not suitable for production use** as the name implies! Scam is a prototyping tool intended for designing REST APIs and supporting frontend development.
Scam is still quite early in development.
## Usage
```sh
npm install express scam --save
```
```js
const path = require('path')
const express = require('express')
const scam = require('scam')
const app = express()
app.set('port', (process.env.PORT || 3333))
scam.init(app, {
data: { ... },
schema: { ... },
databasePath: path.resolve(__dirname, './db.sql')
})
app.listen(app.get('port'), function () {
scam.log()
})
```
See the [demo project](https://github.com/Eiskis/scam-demo/blob/master/index.js) for a better example.
## Schema
```js
{
posts: {
singular: 'post',
plural: 'posts',
fields: [
name: {
type: 'string'
},
body: {
type: 'string'
},
flagged: {
type: 'boolean',
default: false
},
user: {
type: 'user' // Note singular
},
comments: {
type: 'comments' // Note plural
}
]
},
comments: {
...
},
users: {
...
}
}
```
## Data (optional)
```js
{
posts: [
{
name: 'Some Name',
body: 'Body text body text body text',
user: 1,
comments: [1, 2, 3]
},
...
]
}
```
### Options
```js
{
// Set Scam to debug mode (prints internal error messages on 500)
debug: debug,
// Default cache time (can be overwritten per resource in schema)
cache: 0,
// Dummy data as an object, or path to `require` it from
data: require('./data'),
// API schema as an object, or path to `require` it from
schema: require('./schema'),
// Path of the db file to create/remove/update (in-memory DB not yet supported)
databasePath: path.resolve(__dirname, 'db/db.sql')
}
```
### API
```js
let app = require('express')()
let scam = require('scam')
// Prepare a new Scam instance
scam.init(app, options)
// Delete DB if it exists
scam.clearDatabase()
// Init new DB based on schema
scam.setupDatabase()
// Load dummy data
scam.loadData()
// Print instructions and endpoints
scam.log()
// Access props
scam.data
scam.dbPath
scam.endpoints
scam.schema
```
### Deployment
You can deploy a Scam API just like any other express app. A quick way to try it out is to host your repo on GitHub and connect it to Heroku.
### Schema: Field types
The following raw types are supported:
- (`integer`)
- `string`
- `float`
- `boolean`
- `array` (will be stored as string (of JSON) in DB)
- `date`
- `time`
- `timestamp`
Default is `'integer'`, and it doesn't need to be specified.
You can also use the key of another resource type as the `type`. In this case the values are integers and are treated as IDs pointing to resources of the given type.
## Contributing
Scam is still early in development, and pretty hacky. See [todo.md](./TODO.md) for the next steps.
Feel free to [file issues or PRs](https://github.com/Eiskis/scam/issues) though!