Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix commands order to start UI #101

Merged
merged 1 commit into from
Jun 24, 2023
Merged

fix commands order to start UI #101

merged 1 commit into from
Jun 24, 2023

Conversation

xleven
Copy link
Contributor

@xleven xleven commented Jun 24, 2023

There is no buildUi script in /src/chainlit/frontend/package.json so the commands to start UI in CONTRIBUTING.md will not work. Should run buildUi at repo root then cd into frontend folder.

@willydouhard
Copy link
Collaborator

Nice catch, thank you!

@willydouhard willydouhard merged commit c6f8376 into Chainlit:main Jun 24, 2023
1 of 3 checks passed
@xleven
Copy link
Contributor Author

xleven commented Jun 29, 2023

Seems there is still room for improvement:

  1. same commands under "Only contribute to the server" I didn't notice :( -> simply remove the cd will do
  2. command to "Start the server" tries to run target.py which doesn't exsit -> chainlit hello will do
  3. under "Only contribute to the frontend" const name shall be serverUrl and the provided url didn't work on my machine -> please check

I love the project and believe a smooth guide will be a big welcome to future contributors. Please let me know if there is anything unclear.

@willydouhard
Copy link
Collaborator

This is good feedback, thank you! Can you have a look @tpatel ?

tpatel added a commit to tpatel/chainlit that referenced this pull request Jul 3, 2023
- Introduce a conditional instead of relying on modifying the source code
- Modify the contributing docs based on Chainlit#101
tpatel added a commit that referenced this pull request Jul 3, 2023
- Introduce a conditional instead of relying on modifying the source code
- Modify the contributing docs based on #101
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants