{"repo":"thevahidal/soul","free":true,"listed":false,"github":"https://github.com/thevahidal/soul","clone":"git clone https://github.com/thevahidal/soul.git","description":"🕉 Soul | Automatic SQLite RESTful and realtime API server | Build CRUD APIs in minutes!","language":"JavaScript","stars":1682,"topics":["nodejs","realtime","rest","sqlite","sqlite3"],"license":"MIT","category":"databases-storage","readme_excerpt":"A SQLite REST and Realtime server Usage Docker This is a convenient way to run Soul without worrying about your local Node.js version. Soul requires Node.js 22.x , 23.x , 24.x , 25.x , or 26.x (see engines in package.json ) since its better-sqlite3 dependency requires Node 22 or newer. Using the following Dockerfile: Dockerfile You can proceed to building the application. npm 1. Running Soul 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. NOTE: If --cors is left at its default (or explicitly set to ), cookie-based credentials (used for auth) are disabled on cross-origin requests, since browsers reject the combination of a wildcard origin with credentials. Pass an explicit comma-separated origin list via --cors to allow authenticated cross-origin requests. Then to test Soul is working run the following command It should return a list of the tables inside sqlite.db database. 2. Running Soul in Auth mode To run Soul in auth mode, allowing login and signup features with authorization capabilities in your database tables, follow these steps: Run the Soul command with the necessary parameters: Note: When configuring your JWT Secret, it is recommended to use a long string value for enhanced security. It is advisable to use a secret that is at least 10 characters in length. In this example: - The -a flag instructs Soul to run in auth mode. - The --ts flag a","default_branch":null,"files":null,"tree":[],"storefront":"/r/thevahidal","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/thevahidal/soul/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}