Add docs for hosting a static content #208
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Minor re-wording.
IanMayo
previously approved these changes
Jun 17, 2024
thevahidal
requested changes
Jun 17, 2024
docs/self-hosting.md
Outdated
|
|
||
| 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`: |
There was a problem hiding this comment.
The part within the Soul directory needs to be removed as it's only applicable for those who build soul from source code.
docs/self-hosting.md
Outdated
|
|
||
| 5. Run your Soul application: | ||
| ```sh | ||
| npm run dev |
There was a problem hiding this comment.
Also this part is better to be changed to:
soul -d foobar.db --extensions /path/to/_extensions/
README.md
Outdated
| @@ -168,6 +168,10 @@ npm run dev # Start the dev server | |||
|
|
|||
| Make sure to replace the placeholders with the appropriate values for your environment. | |||
|
|
|||
| ## 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 | |||
There was a problem hiding this comment.
The link to self-hosting.md is broken, it has two slashes.
docs/self-hosting.md
Outdated
|
|
||
| **Accessing a React Admin Application via Soul** | ||
|
|
||
|  |
There was a problem hiding this comment.
Also here the slashes are doubled.
|
Hello @thevahidal, I have pushed some fixes, please review them and let me know if there is any other thing to fix. |
thevahidal
approved these changes
Jun 17, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #207
Modifications