GitHub - thevahidal/soul: A SQLite RESTful server

https://github.com/thevahidal/soul • Nov 5, 2022 07:34

Extracto

A SQLite RESTful server. Contribute to thevahidal/soul development by creating an account on GitHub.

Contenido

A SQLite RESTful server

Installation

Install Soul CLI with npm

Usage

Soul is command line tool, after installing it, Run soul -d sqlite.db -p 8000 and it'll start a RESTful API on localhost:8000.

Usage: soul [options]


Options:
      --version             Show version number                        [boolean]
  -d, --database            SQLite database file or :memory: [string] [required]
  -p, --port                Port to listen on                           [number]
  -r, --rate-limit-enabled  Enable rate limiting                       [boolean]
      --help                Show help                                  [boolean]

Then to test Soul is working run the following command

curl http://localhost:8000/api/tables

It should return a list of the tables inside sqlite.db database.

Documentation

API documentation is available while the project is running at http://localhost:8000/api/docs

There's also a list of all endpoints examples at docs/api-examples.md

Development

git clone https://github.com/thevahidal/soul # Clone project

Core API

cd core # Move into the core directory

cp .env.sample .env # Duplicate sample environment variables
nano .env # Update the environment variables

npm install # Install dependencies
npm run dev # Start the dev server

Studio

Make sure that Soul Core API is up and running and then

cd studio # Move into the studio directory

cp .env.sample .env # Duplicate sample environment variables
nano .env # Update the environment variables

npm install # Install dependencies
npm run dev # Start the dev server

Contributing

Contributions are always welcome!

See CONTRIBUTING.md for ways to get started and please adhere to CODE OF CONDUCT.

Authors

@thevahidal

License

MIT