Contributing guidelines

This short document should give you some hints to get started with contributing to TermPair.

Getting started

First, fork the repo and clone it to your computer, then read the section you're interested in.

Install nox.

You can run the server from source with:

nox -s serve-3.10

Install nox.

You can run the terminal client from source with:

nox -s share-3.10

You can pass additional arguments like this

nox -s share-3.10 -- <arguments>

First, get yarn.

Next go to the directory termpair/frontend_src and run

yarn install

to install dependencies.

You can run the development server and hot reload changes. This is the easiest way to quickly statically serve the app from source.

yarn start

To build the production code, run:

yarn build

The static web app will be compiled to termpair/termpair_build/. TermPair will then serve this with nox -s serve.

You can also serve locally with

$ cd termpair/termpair/frontend_build
$ python3 -m http.server 7999 --bind 127.0.0.1
# Serves at http://127.0.01:7999

or deploy to GitHub pages, Vercel, etc.

nox -s publish

If you've found a bug, have a feature request, or would like to contribute documentation, here's what you can do to have your change merged in:

(Recommended) If the problem is non-trivial, you should open an issue to discuss it
Work on a separate branch, and make sure tests pass before pushing them to the remote.
Open a pull request with your changes.