Add a real-estate auction widget to your website, powered by Enchères Immo's API 🚀
This workspace is a mono-repository that contains the following packages:
| Package | Link | README |
|---|---|---|
docs |
WIP | README |
example |
WIP | README |
packages/auction-widget |
 |
README |
packages/widget-client |
 |
README |
This repository contains all open-source packages developed by Enchères Immo, and is maintained by our team of developers. But we also deeply appreciate any contribution from the community, no matter how small or big.
📖 Main repository, with all our public packages.
🐛 Report a bug, please read our contributing guidelines and code of conduct first.
🚨 Report a security vulnerability, and be sure to review our security policy.
💬 Join the discussion, if you have any questions, ideas, or suggestions.
We use pnpm as our package manager, since it's not only faster and safer than npm and yarn, but also because it has better support for monorepos. Global commands are :
| Command | Action |
|---|---|
pnpm install |
Installs dependencies for all packages |
pnpm changeset |
Generate a changeset for a pull request |
For package-specific commands and instructions, please refer to the README of the package, listed above.
We use GitHub Actions to automate our CI/CD pipeline. When a pull request is opened, the following checks are performed for all packages: linting (WIP), testing, and building. Learn more here.
Labels are also automatically added to indicate where the changes are located. Learn more here.
If your changes concern a published package (labels starting with pkg:), you will need to generate a changeset using the pnpm changeset command. This will create a new file in the .changeset directory. Once the pull request is merged, a release pull request will be created, consuming all changesets into changelogs and version bumps. Learn more here.
Merging the release pull request will automatically publish the new versions to npm and the CDN. Learn more here and here.