Corolla

Corolla is a a lightweight SQLite web server. You can use it as a bare-bones web framework.

Example

This Git repostiory includes example Corolla specs, which are JSON files that define a Corolla server's available queries, DB schema, and conversions.

To run the example Corolla spec:

1. Install Rust.

2. Clone this Git repository and navigate into it:

git clone https://github.com/janie314/corolla
cd corolla

3. Start the Corolla server:

cargo run -- -s examples/example_spec.json

Now you can make write queries to the database:

# curl -s -X POST http://localhost:50000/write/write01 \
  -H 'content-type: application/json' \
  -d '{ "vacation_spot": "sandringham" }'

... And read queries!

# curl -s http://localhost:50000/read/read01 | jq
[
  [
    "vacation_spot"
  ],
  [
    "sandringham"
  ]
]

Usage

Usage: corolla [OPTIONS]

Options:
  -d, --db <DB>        Filepath to the SQLite database [default: corolla.sqlite3]
  -p, --port <PORT>    Choose a port to listen on [default: 50000]
  -r, --route <ROUTE>  Base URL for API endpoints [default: ]
  -s, --spec <SPEC>    Filepath to the spec.json file [default: spec.json]
  -t, --test           Test mode?
  -h, --help           Print help
  -V, --version        Print version

JavaScript API

Available via npm at corolla_api.

See the js_api folder and README for more information.

Development

Issues and pull requests welcome!

Testing

Uses Rust's testing framework and Bun's test command.

To test the Corolla server:

cargo test

To test the JS/TS API:

bun test

How to Take a Dependabot Update

1. Rebase against dependabot branch.
2. cargo update
3. Run tests.
4. Accept merge request.
5. git tag current version, then git push --tags.
6. cargo publish