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

Modify self hosting and README docs

Browse Source
This commit is contained in:
AbegaM
2024-06-17 15:57:56 +03:00
parent 356a709386
commit 800b8a5d9c
2 changed files with 5 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@@ -170,7 +170,7 @@ Make sure to replace the placeholders with the appropriate values for your envir
## Hosting Static Content Using Soul
You can host static content using Soul by utilizing its extensions feature. This allows you to expose your static application through Soul, enabling users to access your content without hosting multiple applications. please check [this](./docs//self-hosting.md) document
You can host static content using Soul by utilizing its extensions feature. This allows you to expose your static application through Soul, enabling users to access your content without hosting multiple applications. please check [this](./docs/self-hosting.md) document
## Community

9
docs/self-hosting.md
View File

@@ -1,6 +1,6 @@
# Hosting Static Content Using Soul
You can host static content using Soul by utilizing its extensions feature. This allows you to expose your static application through Soul, simplifying the deployment. Note: your application can gain further server-side capabilities via other Soul extensions.
You can host static content using Soul by utilizing its extensions feature. This allows you to expose your static application through Soul, enabling users to access your content without hosting multiple applications.
Here are diagrams showing how to access Soul APIs when running standalone and how to expose a static client via extensions.
@@ -8,14 +8,13 @@ Here are diagrams showing how to access Soul APIs when running standalone and ho
![soul standalone](../assets/images/soul-standalone.png)
**Accessing a React Admin Application via Soul**
![soul RA app](../assets//images//soul-RA-app.png)
![soul RA app](../assets/images/soul-RA-app.png)
## Steps
In this guide, we will demonstrate how to host a static `React Admin` application.
1. Create an `_extensions` folder within the `Soul` directory and add a file named `api.js`:
1. Create an `_extensions` folder and add an `api.js` file to it.:
```sh
mkdir _extensions && touch _extensions/api.js
```
@@ -47,7 +46,7 @@ In this guide, we will demonstrate how to host a static `React Admin` applicatio
5. Run your Soul application:
```sh
npm run dev
soul -d foobar.db --extensions /path/to/_extensions/
```
6. To verify that the app is working, open the following URL in your browser:
```