Before starting, you may need to know how to contribute in a good way. You can follow the rules here:
- Node.js 24 (see
.nvmrc) - Yarn 1.x as the package manager
- Clone this repo with git.
- Run
yarn installinside the project directory. - Copy the env file:
cp .env.example .env. Every key is optional — without a given token the matching activity widget just renders empty.SITE_ACCENT_COLORandSITE_TEXT_COLORcontrol the theme colors. - Start the dev server:
-
yarn dev→ serves all three domains at once. Openhttp://localhost:3000and pick the domain via a path prefix, e.g.localhost:3000/diegocosta.meorlocalhost:3000/diegocoxta.com. -
Or pin it to a single domain instead:
yarn dev:diegocosta.com.bryarn dev:diegocosta.meyarn dev:diegocoxta.com
These set the
DEV_SITEenv var, which tellsproxy.tsto map plainlocalhostto that domain, so no path prefix is needed.
-
See AGENTS.md for how the codebase is organized.
| Script | Description |
|---|---|
yarn build |
Production build |
yarn start |
Serve the production build |
yarn lint |
Run ESLint |
yarn prettier |
Format the codebase |
yarn stylelint |
Lint & fix CSS Modules |
yarn upgrade-latest |
Interactive dependency upgrade |
If you encounter an issue with the project, you are welcome to submit a bug report. Before that, please search for similar issues. It's possible somebody has already encountered this issue.
If you want to contribute to the repository, follow these steps:
- Fork the repo and develop.
- Check that your code follows the linter rules:
yarn prettier && yarn lint && yarn stylelint - Test your code changes manually and make sure the project builds (
yarn build). - Commit your changes.
- Push to your fork and submit a pull request.