Skip to content

Latest commit

 

History

History
135 lines (92 loc) · 4.21 KB

CONTRIBUTING.md

File metadata and controls

135 lines (92 loc) · 4.21 KB
Raw

Contribute to Chainlit

To contribute to Chainlit, you first need to setup the project on your local machine.

Table of Contents

Local setup

Requirements

  1. Python >= 3.9
  2. Poetry (See how to install)
  3. NodeJS >= 16 (See how to install)
  4. Pnpm (See how to install)

Note If you are on windows, some pnpm commands like pnpm run formatPython won't work. You can fix this by changing the pnpm script-shell to bash: pnpm config set script-shell "C:\\Program Files\\git\\bin\\bash.exe" (default x64 install location, Info)

Setup the repo

With this setup you can easily code in your fork and fetch updates from the main repository.

  1. Go to https://github.com/Chainlit/chainlit/fork to fork the chainlit code into your own repository.
  2. Clone your fork locally
git clone https://github.com/YOUR_USERNAME/YOUR_FORK.git
  1. Go into your fork and list the current configured remote repository.
$ git remote -v
> origin  https://github.com/YOUR_USERNAME/YOUR_FORK.git (fetch)
> origin  https://github.com/YOUR_USERNAME/YOUR_FORK.git (push)
  1. Specify the new remote upstream repository that will be synced with the fork.
git remote add upstream https://github.com/Chainlit/chainlit.git
  1. Verify the new upstream repository you've specified for your fork.
$ git remote -v
> origin    https://github.com/YOUR_USERNAME/YOUR_FORK.git (fetch)
> origin    https://github.com/YOUR_USERNAME/YOUR_FORK.git (push)
> upstream  https://github.com/Chainlit/chainlit.git (fetch)
> upstream  https://github.com/Chainlit/chainlit.git (push)

Install dependencies

The following command will install Python dependencies, Node (pnpm) dependencies and build the frontend.

cd backend
poetry install --with tests --with mypy --with dev

Start the Chainlit server from source

Start by running backend/hello.py as an example.

cd backend
poetry shell
chainlit run chainlit/hello.py

You should now be able to access the Chainlit app you just launched on http://127.0.0.1:8000.

If you've made it this far, you can now replace chainlit/hello.py by your own target. 😎

Start the UI from source

First, you will have to start the server either from source or with chainlit run.... Since we are starting the UI from source, you can start the server with the -h (headless) option.

Then, start the UI.

cd frontend
pnpm run dev --port 5174

If you visit http://127.0.0.1:5174/, it should connect to your local server. If the local server is not running, it should say that it can't connect to the server.

Run the tests

Backend unit tests

This will run the backend's unit tests.

cd backend
pytest

E2E tests

This will run end to end tests, assessing both the frontend, the backend and their interaction:

pnpm test

(Go grab a cup of something, this will take a while.)

Once you create a pull request, the tests will automatically run. It is a good practice to run the tests locally before pushing.

Make sure to run poetry install again whenever you've updated the frontend!

Run one test

  1. Find the folder containing the e2e test that you're looking for in cypress/e2e.
  2. Run SINGLE_TEST=FOLDER pnpm test and change FOLDER with the folder from the previous step (example: SINGLE_TEST=scoped_elements pnpm run test).