Create readme #814
Open
Create readme #814
+197
−35
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
adhityamamallan
requested changes
Feb 11, 2025
|
|
||
| #### Developing cadence-web against cadence composed docker | ||
|
|
||
| To start development against a dockerized cadence services, run the following command from the root of the project |
There was a problem hiding this comment.
Suggested change
| To start development against a dockerized cadence services, run the following command from the root of the project | |
| To start development against a dockerized cadence server, run the following command from the root of the project |
| @@ -0,0 +1,89 @@ | |||
| # modified version of https://github.com/cadence-workflow/cadence/blob/master/docker/docker-compose-es-v7.yml | |||
There was a problem hiding this comment.
You could mention what the exact modifications are
|
|
||
| ## Deploy on Vercel | ||
| ## Licence |
There was a problem hiding this comment.
Suggested change
| ## Licence | |
| ## License |
nit
|
|
||
| To learn more about Next.js, take a look at the following resources: | ||
| `build`: `Generates production builds` |
There was a problem hiding this comment.
The line breaks are not being rendered correctly here. You could use a table if that is easier
|
|
||
| ### Using cadence-web | ||
|
|
||
| Latest version of `cadence-web` is included in `cadence` composed docker containers that can be found [here][cadence]. To start using it clone `cadence` repo and run the following command |
There was a problem hiding this comment.
Suggested change
| Latest version of `cadence-web` is included in `cadence` composed docker containers that can be found [here][cadence]. To start using it clone `cadence` repo and run the following command | |
| The latest version of `cadence-web` is included in the `cadence` composed docker containers in the [main Cadence repository][cadence]. Follow the instructions there to get started. |
You can remove the docker-compose command here as well, users can follow the server repo readme for this.
|
|
||
| To learn more about Next.js, take a look at the following resources: | ||
| `build`: `Generates production builds` |
There was a problem hiding this comment.
Suggested change
| `build`: `Generates production builds` | |
| `build`: `Generate a production build` |
nit
| `build`: `Generates production builds` | ||
| `start`: `Starts a production build` | ||
| `dev`: `Run development server` | ||
| `install-idl`: `Downloads idl files required for building/running the project` |
There was a problem hiding this comment.
Suggested change
| `install-idl`: `Downloads idl files required for building/running the project` | |
| `install-idl`: `Download idl files required for building/running the project` |
nit
|
|
||
| [](https://github.com/uber/cadence-web/actions/workflows/build.yml) [](https://hub.docker.com/r/ubercadence/web/tags) | ||
|
|
||
| Cadence is a distributed, scalable, durable, and highly available orchestration engine we developed at Uber Engineering to execute asynchronous long-running business logic in a scalable and resilient way. |
There was a problem hiding this comment.
You can have the link to Cadence here instead of in line 7.
|
|
||
| #### Running development environment | ||
|
|
||
| To run development server, follow this steps: |
There was a problem hiding this comment.
Suggested change
| To run development server, follow this steps: | |
| To run the development server, follow these steps: |
nit
| ``` | ||
| npm install && npm run install-idl && npm run generate:idl | ||
| ``` | ||
| 2. Run development server using |
There was a problem hiding this comment.
Suggested change
| 2. Run development server using | |
| 2. Run the development server using |
nit
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.
Summary
Creating readme for v4 and change docker container default values to work with cadence composed docker
Changes
docker-compose.prod.yml