3.2 KiB
Contributing to Bolt.new Fork
First off, thank you for considering contributing to Bolt.new! This fork aims to expand the capabilities of the original project by integrating multiple LLM providers and enhancing functionality. Every contribution helps make Bolt.new a better tool for developers worldwide.
📋 Table of Contents
- Code of Conduct
- How Can I Contribute?
- Pull Request Guidelines
- Coding Standards
- Development Setup
- Project Structure
Code of Conduct
This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to the project maintainers.
How Can I Contribute?
🐞 Reporting Bugs and Feature Requests
- Check the issue tracker to avoid duplicates
- Use the issue templates when available
- Include as much relevant information as possible
- For bugs, add steps to reproduce the issue
🔧 Code Contributions
- Fork the repository
- Create a new branch for your feature/fix
- Write your code
- Submit a pull request
✨ Becoming a Core Contributor
We're looking for dedicated contributors to help maintain and grow this project. If you're interested in becoming a core contributor, please fill out our Contributor Application Form.
Pull Request Guidelines
📝 PR Checklist
- Branch from the main branch
- Update documentation if needed
- Manually verify all new functionality works as expected
- Keep PRs focused and atomic
👀 Review Process
- Manually test the changes
- At least one maintainer review required
- Address all review comments
- Maintain clean commit history
Coding Standards
💻 General Guidelines
- Follow existing code style
- Comment complex logic
- Keep functions focused and small
- Use meaningful variable names
Development Setup
🔄 Initial Setup
- Clone the repository:
git clone https://github.com/coleam00/bolt.new-any-llm.git
- Install dependencies:
pnpm install
- Set up environment variables:
- Rename
.env.example
to.env.local
- Add your LLM API keys (only set the ones you plan to use):
- Rename
GROQ_API_KEY=XXX
OPENAI_API_KEY=XXX
ANTHROPIC_API_KEY=XXX
...
- Optionally set debug level:
VITE_LOG_LEVEL=debug
Important: Never commit your .env.local
file to version control. It's already included in .gitignore.
🚀 Running the Development Server
pnpm run dev
Note: You will need Google Chrome Canary to run this locally if you use Chrome! It's an easy install and a good browser for web development anyway.
Testing
Run the test suite with:
pnpm test
Deployment
To deploy the application to Cloudflare Pages:
pnpm run deploy
Make sure you have the necessary permissions and Wrangler is correctly configured for your Cloudflare account.
Docker Dev
To build docker image
docker build -t bolt-ai .
To run bolt dev in docker(Add ANTHROPIC_API_KEY=XXX before running)
docker run -p 5173:5173 --env-file .env.local bolt-ai