Thank you for taking the time to contribute to ReScript Relay Router!
This repository uses yarn 1 as a package manager.
If you spot a problem with the docs, search if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue form.
Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters.
- Fork the repository.
-
Using GitHub Desktop:
- Getting started with GitHub Desktop will guide you through setting up Desktop.
- Once Desktop is set up, you can use it to fork the repo!
-
Using the command line:
- Fork the repo so that you can make your changes without affecting the original project until you're ready to merge them.
-
Install or update to Node.js v16 or newer. You must have yarn 1 installed.
-
Install the project's dependencies using
yarn -
Start the development server using
yarn dev. This will start all the tools for you. -
You can now view the site at
http://localhost:9999and make changes.
When you're ready to stop your local server, type Ctrl+C in your terminal window.
To build the project in production mode run yarn build. You can preview the production build using yarn serve.
Once you're satisfied with the production build you can package a new version of the router for use in other projects by running ./buildPackage.sh which will copy the router files into the _release/ folder.