diff --git a/README.md b/README.md index 1f74522..5e83071 100644 --- a/README.md +++ b/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. + +

+ +

## 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 diff --git a/core/package-lock.json b/core/package-lock.json index 09d4ea4..e95000f 100644 --- a/core/package-lock.json +++ b/core/package-lock.json @@ -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", diff --git a/core/src/swagger/swagger.json b/core/src/swagger/swagger.json index e066a91..a600806 100644 --- a/core/src/swagger/swagger.json +++ b/core/src/swagger/swagger.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "0.2.0", + "version": "0.2.1", "title": "Soul API", "description": "API Documentation for Soul, a SQLite REST and realtime server. " }, diff --git a/docs/soul-studio.png b/docs/soul-studio.png new file mode 100644 index 0000000..f98ba45 Binary files /dev/null and b/docs/soul-studio.png differ diff --git a/studio/package-lock.json b/studio/package-lock.json index 20db669..cc50211 100644 --- a/studio/package-lock.json +++ b/studio/package-lock.json @@ -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", diff --git a/studio/package.json b/studio/package.json index 67452b5..4b13a28 100644 --- a/studio/package.json +++ b/studio/package.json @@ -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" },