Soul Studio screenshot added to README.
This commit is contained in:
11
README.md
11
README.md
@@ -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 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
|
||||
|
||||
@@ -55,6 +64,7 @@ git clone https://github.com/thevahidal/soul # Clone project
|
||||
```
|
||||
|
||||
### Core API
|
||||
|
||||
```bash
|
||||
cd core # Move into the core directory
|
||||
|
||||
@@ -66,6 +76,7 @@ npm run dev # Start the dev server
|
||||
```
|
||||
|
||||
### Studio
|
||||
|
||||
Make sure that Soul Core API is up and running and then
|
||||
```bash
|
||||
cd studio # Move into the studio directory
|
||||
|
||||
4
core/package-lock.json
generated
4
core/package-lock.json
generated
@@ -1,12 +1,12 @@
|
||||
{
|
||||
"name": "soul-cli",
|
||||
"version": "0.0.9",
|
||||
"version": "0.2.1",
|
||||
"lockfileVersion": 2,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "soul-cli",
|
||||
"version": "0.0.9",
|
||||
"version": "0.2.1",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"better-sqlite3": "^7.6.2",
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"swagger": "2.0",
|
||||
"info": {
|
||||
"version": "0.2.0",
|
||||
"version": "0.2.1",
|
||||
"title": "Soul API",
|
||||
"description": "API Documentation for <b>Soul</b>, a SQLite REST and realtime server. "
|
||||
},
|
||||
|
||||
BIN
docs/soul-studio.png
Normal file
BIN
docs/soul-studio.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 41 KiB |
5
studio/package-lock.json
generated
5
studio/package-lock.json
generated
@@ -1,12 +1,13 @@
|
||||
{
|
||||
"name": "studio",
|
||||
"name": "soul-studio",
|
||||
"version": "0.0.1",
|
||||
"lockfileVersion": 2,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "studio",
|
||||
"name": "soul-studio",
|
||||
"version": "0.0.1",
|
||||
"license": "MIT",
|
||||
"devDependencies": {
|
||||
"@sveltejs/adapter-auto": "next",
|
||||
"@sveltejs/adapter-node": "^1.0.0-next.98",
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
"version": "0.0.1",
|
||||
"description": "GUI for Soul: A SQLite REST and realtime server",
|
||||
"scripts": {
|
||||
"dev": "vite dev",
|
||||
"dev": "vite dev --port 3000",
|
||||
"build": "vite build",
|
||||
"preview": "vite preview"
|
||||
},
|
||||
|
||||
Reference in New Issue
Block a user