tabshift/soul-server
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Soul Studio screenshot added to README.

Browse Source
This commit is contained in:
Vahid Al
2022-12-11 17:13:43 +03:30
parent 8b7d20bae6
commit 43ff91bf3e
6 changed files with 18 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@@ -47,6 +47,15 @@ For websocket examples, check [docs/ws-examples.md](docs/ws-examples.md)
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](docs/extensions-examples.md) 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](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.
<p align="center">
<img src='docs/soul-studio.png' style="">
</p>
## Development ## Development
@@ -55,6 +64,7 @@ git clone https://github.com/thevahidal/soul # Clone project
``` ```
### Core API ### Core API
```bash ```bash
cd core # Move into the core directory cd core # Move into the core directory
@@ -66,6 +76,7 @@ npm run dev # Start the dev server
``` ```
### Studio ### Studio
Make sure that Soul Core API is up and running and then Make sure that Soul Core API is up and running and then
```bash ```bash
cd studio # Move into the studio directory cd studio # Move into the studio directory

4
core/package-lock.json generated
View File

@@ -1,12 +1,12 @@
{ {
"name": "soul-cli", "name": "soul-cli",
"version": "0.0.9", "version": "0.2.1",
"lockfileVersion": 2, "lockfileVersion": 2,
"requires": true, "requires": true,
"packages": { "packages": {
"": { "": {
"name": "soul-cli", "name": "soul-cli",
"version": "0.0.9", "version": "0.2.1",
"license": "MIT", "license": "MIT",
"dependencies": { "dependencies": {
"better-sqlite3": "^7.6.2", "better-sqlite3": "^7.6.2",

2
core/src/swagger/swagger.json
View File

@@ -1,7 +1,7 @@
{ {
"swagger": "2.0", "swagger": "2.0",
"info": { "info": {
"version": "0.2.0", "version": "0.2.1",
"title": "Soul API", "title": "Soul API",
"description": "API Documentation for <b>Soul</b>, a SQLite REST and realtime server. " "description": "API Documentation for <b>Soul</b>, a SQLite REST and realtime server. "
}, },

BIN
docs/soul-studio.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 41 KiB

5
studio/package-lock.json generated
View File

@@ -1,12 +1,13 @@
{ {
"name": "studio", "name": "soul-studio",
"version": "0.0.1", "version": "0.0.1",
"lockfileVersion": 2, "lockfileVersion": 2,
"requires": true, "requires": true,
"packages": { "packages": {
"": { "": {
"name": "studio", "name": "soul-studio",
"version": "0.0.1", "version": "0.0.1",
"license": "MIT",
"devDependencies": { "devDependencies": {
"@sveltejs/adapter-auto": "next", "@sveltejs/adapter-auto": "next",
"@sveltejs/adapter-node": "^1.0.0-next.98", "@sveltejs/adapter-node": "^1.0.0-next.98",

2
studio/package.json
View File

@@ -3,7 +3,7 @@
"version": "0.0.1", "version": "0.0.1",
"description": "GUI for Soul: A SQLite REST and realtime server", "description": "GUI for Soul: A SQLite REST and realtime server",
"scripts": { "scripts": {
"dev": "vite dev", "dev": "vite dev --port 3000",
"build": "vite build", "build": "vite build",
"preview": "vite preview" "preview": "vite preview"
}, },