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

Merge pull request #168 from thevahidal/fix-static-page-broken-links

Browse Source 
Fix static page broken links
This commit is contained in:
Vahid Al
2024-03-21 13:31:18 +03:30
committed by GitHub
parent 7390bc4a03 96addfa049
commit c512c443a1
2 changed files with 13 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
docs/api-examples.md
View File

@@ -11,7 +11,9 @@ To follow the below examples we need to download a sample database and also inst
```bash ```bash
wget https://raw.githubusercontent.com/lerocha/chinook-database/master/ChinookDatabase/DataSources/Chinook_Sqlite.sqlite # Download sample sqlite database wget https://raw.githubusercontent.com/lerocha/chinook-database/master/ChinookDatabase/DataSources/Chinook_Sqlite.sqlite # Download sample sqlite database
``` ```
### Using Soul CLI ### Using Soul CLI
```bash ```bash
npm install -g soul-cli npm install -g soul-cli
soul -d ./Chinook_Sqlite.sqlite -p 8000 soul -d ./Chinook_Sqlite.sqlite -p 8000
@@ -26,15 +28,14 @@ npm install # Install dependencies
npm link # might need `sudo` npm link # might need `sudo`
soul -d ./Chinook_Sqlite.sqlite -p 8000 soul -d ./Chinook_Sqlite.sqlite -p 8000
``` ```
</details>
</details>
## Namespaces ## Namespaces
1. [/api/tables](/docs/api/tables-examples.md) Examples for Tables endpoints 1. [/api/tables](docs/api/tables-examples.md) Examples for Tables endpoints
2. [/api/rows](/docs/api/rows-examples.md) Examples for Rows endpoints 2. [/api/rows](docs/api/rows-examples.md) Examples for Rows endpoints
3. [/api/](/docs/api/root-examples.md) Examples for Root endpoints 3. [/api/](docs/api/root-examples.md) Examples for Root endpoints
## Handling Errors ## Handling Errors
@@ -54,9 +55,9 @@ curl --request POST \
```json ```json
{ {
"message": "table artists already exists", "message": "table artists already exists",
"error": { "error": {
"code": "SQLITE_ERROR" "code": "SQLITE_ERROR"
} }
} }
``` ```

5
docs/ws-examples.md
View File

@@ -20,6 +20,7 @@ npm i -g wscat # Install websocket client
``` ```
### Using Soul CLI ### Using Soul CLI
```bash ```bash
npm install -g soul-cli npm install -g soul-cli
soul -d ./Chinook_Sqlite.sqlite -p 8000 soul -d ./Chinook_Sqlite.sqlite -p 8000
@@ -34,9 +35,9 @@ npm install # Install dependencies
npm link # might need `sudo` npm link # might need `sudo`
soul -d ./Chinook_Sqlite.sqlite -p 8000 soul -d ./Chinook_Sqlite.sqlite -p 8000
``` ```
</details>
</details>
## Namespaces ## Namespaces
1. [/ws/tables](/docs/ws/rows-examples.md) Examples for Rows websockets 1. [/ws/tables](docs/ws/rows-examples.md) Examples for Rows websockets