Skip to content

Add a real-estate auction widget to your website, powered by Enchères Immo's API 🚀

Notifications You must be signed in to change notification settings

encheres-immo/auction-widget

Repository files navigation

Enchères Immo's auction widget

Add a real-estate auction widget to your website, powered by Enchères Immo's API 🚀

Production

This workspace is a mono-repository that contains the following packages:

Package Link README
docs WIP README
example WIP README
packages/auction-widget npm version README
packages/widget-client npm version README

Development

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.

Quick Links

📖 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.

Getting Started

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
pnpm changeset Generate a changelog

For package-specific commands and instructions, please refer to the README of the package, listed above.