Warning

Code in this repository is not audited and may contain serious security holes. Use at your own risk.

Harbour

Project Structure

Harbour is a monorepo containing the following packages:

• contracts: Smart contracts for the Harbour protocol
• webapp: Web application
• validagtor: Validator service
• docs: Documentation

Documentation

• Architecture Documentation - Overview of the project architecture
• Deployment Documentation - Information on latest deployments

Getting Started

1. Clone the repository:

git clone https://github.com/safe-research/harbour.git

2. Navigate to the project directory:

cd harbour

3. Install dependencies:

npm install

4. Follow the setup instructions in the documentation:
   • For contracts: See contracts/README.md
   • For webapp: See webapp/README.md
   • For validator: See validator/README.md

Development

• npm run format - Format code using Biome
• npm run lint - Lint code using Biome
• npm run lint:fix - Fix linting issues
• npm run check - Run Biome checks
• npm run test - Run tests across all packages

Contributing

Contributions are welcome! Please see CONTRIBUTING.md for guidelines.