[enhancement/readme] Improved readme #48
Open
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
Open
firasrg
suggested changes
Aug 7, 2024
| @@ -2,14 +2,39 @@ | |||
| ## Prerequisites | |||
| - Java 21 | |||
| - Docker | |||
| ## Used technologies | |||
There was a problem hiding this comment.
- Rename to "Technology Stack".
- Merge this section with
Prerequisitessection; - Add a note in which you inform that Docker is mandatory.
- Add version number of each technology used.
|
|
||
| # Structure of the project | ||
| There are two projects, JShellAPI and JShellWrapper | ||
| JShellAPI is a REST API, and whenever some code is received, it will create a session, by creating a docker container, which will run JShellWrapper inside and then execute the given code in JShellWrapper. | ||
| There are two projects, JShellAPI and JShellWrapper. |
There was a problem hiding this comment.
- It would be nice to make JShellAPI and JShellWrapper words as links.
- it's better to say
This project is composed of 2 sub-projects, both are Backend services (as indicated in the name of the repo) - I highly suggest to share the source of the diagram so we can update anytime we want.
| JShellAPI is a REST API, and whenever some code is received, it will create a session, by creating a docker container, which will run JShellWrapper inside and then execute the given code in JShellWrapper. | ||
| There are two projects, JShellAPI and JShellWrapper. | ||
|
|
||
| JShellAPI is a REST API, where whenever some code is received, it will create a session, by creating a docker container, which will run JShellWrapper inside and then execute the given code. |
There was a problem hiding this comment.
- Add a title here to inform that this section is about the 1st sub-project;
- Bring any relevant information to JShellApi project under this section;
- It would be better to make
REST APIkeyword as a link to Restful API website; - We need to explain to explain that REST API (JShellApi) is the entry point to JShellWrapper and not the opposite.
- We need to explain why we don't allow executing the code within the REST API service (reasons or links);
|
|
||
| JShellAPI is a REST API, where whenever some code is received, it will create a session, by creating a docker container, which will run JShellWrapper inside and then execute the given code. | ||
|
|
||
|  |
There was a problem hiding this comment.
- Why not putting the diagram img within the repo ?
- There is no mention of a scenario for using an existing session;
- Why there is no mention to session on the diagram?
|
|
||
|  | ||
|
|
||
| There are three unrelated ways to run JShellPlaygroundBackend: |
There was a problem hiding this comment.
it would be better to say There are 3 ...
| * * On `Windows Powershell`, use `$env:evalTimeoutSeconds=15 && $env:sysOutCharLimit=1024` | ||
| * * On `Linux Shell`, use `export evalTimeoutSeconds=15 && export sysOutCharLimit=1024` | ||
| * Run `./gradlew JShellWrapper:run` | ||
| * Alternatively, run: |
There was a problem hiding this comment.
I'd suggest to delete this part :
* Set the environment variable `evalTimeoutSeconds=15` and `sysOutCharLimit=1024`
* * On `Windows CMD`, use `set evalTimeoutSeconds=15 && set sysOutCharLimit=1024`
* * On `Windows Powershell`, use `$env:evalTimeoutSeconds=15 && $env:sysOutCharLimit=1024`
* * On `Linux Shell`, use `export evalTimeoutSeconds=15 && export sysOutCharLimit=1024`
* Run `./gradlew JShellWrapper:run`
* Alternatively, run:
| curl --request POST --url http://localhost:8080/jshell/eval/test --data '2+2' | ||
| ``` | ||
|
|
||
| ### How to use JShellApi ? |
There was a problem hiding this comment.
Please place this under a JShellAPi section
| curl --request POST --url http://localhost:8080/jshell/eval/test --data '2+2' | ||
| ``` | ||
|
|
||
| ### How to use JShellApi ? | ||
| See [JShellAPI README](JShellAPI/README.MD) |
There was a problem hiding this comment.
It would be better to bring the content here and add note to inform that it's NOT updated
| @@ -45,5 +70,12 @@ JShellAPI is a REST API, and whenever some code is received, it will create a se | |||
| -application.yaml | |||
| ``` | |||
|
|
|||
| ## How to use JShellApi ? | |||
| ### Try JShell API | |||
There was a problem hiding this comment.
Place this section under JShellApi section
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.
Pull-request
Changes
Closes Issue: #44
Description
Replace this sentence with general description of what your Pull Request does.