Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Master into develop #132

Open
wants to merge 6 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,4 @@ yarn-error.log*

.idea

storybook-static
storybook-static
84 changes: 84 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
# Contributing to Zazelenimo

Thank you for your interest in contributing to Zazelenimo! We're excited to have you join our community of contributors working to improve participatory budgeting for green spaces.

## 🚀 Getting Started

1. Fork the repository
2. Clone your fork:
```bash
git clone https://github.com/your-username/zazelenimo.git
```
3. Create a new branch:
```bash
git checkout -b feature/your-feature-name
```

## 💻 Development Setup

1. Install dependencies:
```bash
pnpm i
```

2. Start the development server:
```bash
pnpm dev
```

## 🤝 Contribution Guidelines

### Code Style
- Follow the existing code style
- Use meaningful variable and function names
- Add comments for complex logic
- Write clean, maintainable code

### Commits
- Use clear, descriptive commit messages
- Follow conventional commits format:
- `feat:` for new features
- `fix:` for bug fixes
- `docs:` for documentation changes
- `style:` for formatting changes
- `refactor:` for code refactoring
- `test:` for adding tests
- `chore:` for maintenance tasks

### Pull Requests
1. Update your fork to the latest main branch
2. Test your changes thoroughly
3. Update documentation if needed
4. Create a pull request with a clear description of changes
5. Link any related issues

## 🐛 Reporting Issues

- Use the GitHub issue tracker
- Check if the issue already exists
- Include clear steps to reproduce
- Provide relevant system information
- Add screenshots if applicable

## 📝 Documentation

- Update documentation for any new features
- Keep the README.md up to date
- Add inline comments for complex code

## 🌍 Translations

We welcome contributions to improve our Croatian translations or add new languages. Please contact the maintainers before starting significant translation work.

## 🤔 Questions?

- Check our [Documentation](https://docs.zazelenimo.com/)
- Create a GitHub Discussion

## 📜 Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct (see CODE_OF_CONDUCT.md).

## 📄 License

By contributing to Zazelenimo, you agree that your contributions will be licensed under the MIT License.
7 changes: 7 additions & 0 deletions FUNDING.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"drips": {
"ethereum": {
"ownedBy": "0xeADe5F65F6413758b3b29b6EE4514f787AECe468"
}
}
}
63 changes: 53 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,61 @@
# muqa
Municipal Quadratic Funding Initiative
# 🌿 Zazelenimo - Municipal Quadratic Funding Initiative

## Installation
```bash
# Install the pnpm package manager
npm install -g pnpm # via npm
brew install pnpm # or via homebrew
## 🌍 About

Zazelenimo is an innovative online platform for implementing participatory budgeting programs in cities, with a focus on green space projects. This pilot project, part of the Municipal Quadratic Funding Initiative (MUQA), is based on Ethereum technology and the concept of Quadratic Funding.

### 🏙️ Current Implementation: Split, Croatia

The current implementation is designed for the city of Split, allowing citizens to propose, discuss, and vote on green space projects.

## 🚀 Features

- 📝 Project Proposal Submission
- 🗳️ Quadratic Funding Voting Mechanism
- 💬 Public Discussion Forum
- 🗺️ Interactive Project Map
- 🌐 Multi-language Support (English and Croatian)

## 🛠️ Technology Stack

- Next.js
- Ethereum Blockchain
- Quadratic Funding Algorithm

## 🏗️ Installation
```bash
# Install dependencies
pnpm i

# Run in dev environment
pnpm dev

# Build
pnpm build

# Run in dev environment
pnpm dev
```

## 🤝 Contributing

We welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING.md) for more details.

## 📚 Documentation

For more detailed information, please visit our [Documentation](https://docs.zazelenimo.com/).

## 💬 Community

Join our [Forum](https://forum.zazelenimo.com/) to participate in discussions and stay updated.

## 🔗 Useful Links
- [Live site](https://zazelenimo.com)
- [MUQA Initiative](https://muqa.org)
- [GitHub Repository](https://github.com/muqa-org/zazelenimo)
- [Facebook Page](https://www.facebook.com/parkovisplit)

## 🙏 Acknowledgements

This project is funded by the Ethereum Foundation.

## 📄 License

This project is licensed under the [MIT License](LICENSE).
16 changes: 16 additions & 0 deletions apps/platform/.env.example
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
NEXT_PUBLIC_URL=https://zazelenimo.com

# NEXT_PUBLIC_CHAIN=POLYGON
# NEXT_PUBLIC_CHAIN=ARBITRUM_SEPOLIA
# NEXT_PUBLIC_CHAIN=AVALANCHE_FUJI
Expand All @@ -21,12 +23,19 @@ NEXT_PUBLIC_ARBITRUM_SEPOLIA_TENDERLY_RPC=your-tenderly-rpc-url
NEXT_PUBLIC_AVALANCHE_FUJI_COMETH_API_KEY=your-cometh-avalanche-fuji-api-key
NEXT_PUBLIC_AVALANCHE_FUJI_TENDERLY_RPC=your-tenderly-rpc-url

# OPTIMISM_SEPOLIA
NEXT_PUBLIC_OPTIMISM_SEPOLIA_COMETH_API_KEY=your-cometh-optimism-sepolia-api-key
NEXT_PUBLIC_OPTIMISM_SEPOLIA_TENDERLY_RPC=your-tenderly-rpc-url

NEXT_PUBLIC_GOOGLE_API_KEY=your-google-api-key

# Feature flags
NEXT_PUBLIC_SHOW_WALLET_STATUS=
NEXT_PUBLIC_SHOW_CONNECT_BUTTON=
NEXT_PUBLIC_SHOW_CART_LINK=
NEXT_PUBLIC_ALLOW_ROUND_INPUT=
NEXT_PUBLIC_USE_DUMMY_DATA=
NEXT_PUBLIC_SHOW_PROJECTS_PAGE=
Comment on lines +36 to +38
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Verification agent

❓ Verification inconclusive

New feature flags need documentation.

These feature flags control important application behavior. Ensure they're properly documented for other developers.


🏁 Script executed:

#!/bin/bash
# Check if these feature flags are documented in README or other docs
rg -i "(NEXT_PUBLIC_ALLOW_ROUND_INPUT|NEXT_PUBLIC_USE_DUMMY_DATA|NEXT_PUBLIC_SHOW_PROJECTS_PAGE)" --type md

Length of output: 109


Documentation required for new feature flags

The environment variables defined in apps/platform/.env.example (lines 36–38) are not referenced in our Markdown documentation. Since these flags control significant application behavior, please add detailed documentation—such as an entry in the README or a dedicated section in our docs folder—that explains their purpose, acceptable values, and any impact on the application.

  • NEXT_PUBLIC_ALLOW_ROUND_INPUT
  • NEXT_PUBLIC_USE_DUMMY_DATA
  • NEXT_PUBLIC_SHOW_PROJECTS_PAGE


NEXTAUTH_URL=http://localhost:3000
NEXTAUTH_SECRET=your-nextauth-secret
Expand All @@ -36,3 +45,10 @@ MAILGUN_API_KEY=
MAILGUN_DOMAIN=
MAILGUN_API_HOST=
MAILGUN_RECEIVER_EMAIL=

# PostHog settings
NEXT_PUBLIC_POSTHOG_API_KEY=

# Custom grants stack indexer url
GRANTS_STACK_INDEXER_URL=
NEXT_PUBLIC_IPFS_GATEWAY_URL=
Loading