A SQLite REST and Realtime server
Installation
Install Soul CLI with npm
npm install -g soul-cliUsage
Soul is command line tool, after installing it,
Run soul -d sqlite.db -p 8000 and it'll start a REST API on http://localhost:8000 and a Websocket server on ws://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/tablesIt 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
For websocket examples, check docs/ws-examples.md
Extending Soul
Soul is able to be extended (e.g. Adding custom APIs) via extensions, you can find a list of extensions at docs/extensions-examples.md
Soul Studio
Soul Studio provides a GUI to work with your database.
Right now Soul Studio is in early stages of development and not useful to work with.
Development
git clone https://github.com/thevahidal/soul # Clone projectCore 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 serverStudio
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 serverCommunity
Join the discussion in our Discord server and help making Soul together.
Contributing
Contributions are always welcome!
See CONTRIBUTING.md for ways to get started and please adhere to CODE OF CONDUCT.
