bolt.new-any-llm/CONTRIBUTING.md

121 lines
3.2 KiB
Markdown
Raw Normal View History

# Contributing to Bolt.new Fork
2024-10-03 12:12:13 +00:00
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.
2024-07-10 16:44:39 +00:00
## 📋 Table of Contents
- [Code of Conduct](#code-of-conduct)
- [How Can I Contribute?](#how-can-i-contribute)
- [Pull Request Guidelines](#pull-request-guidelines)
- [Coding Standards](#coding-standards)
- [Development Setup](#development-setup)
- [Project Structure](#project-structure)
2024-10-01 00:14:28 +00:00
## Code of Conduct
2024-10-01 00:14:28 +00:00
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.
2024-10-01 00:14:28 +00:00
## How Can I Contribute?
2024-10-01 00:14:28 +00:00
### 🐞 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
2024-10-01 00:14:28 +00:00
### 🔧 Code Contributions
1. Fork the repository
2. Create a new branch for your feature/fix
3. Write your code
4. Submit a pull request
2024-07-10 16:44:39 +00:00
### ✨ 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](https://forms.gle/TBSteXSDCtBDwr5m7).
2024-10-03 04:24:22 +00:00
## Pull Request Guidelines
2024-10-03 04:24:22 +00:00
### 📝 PR Checklist
- [ ] Branch from the main branch
- [ ] Update documentation if needed
- [ ] Manually verify all new functionality works as expected
- [ ] Keep PRs focused and atomic
2024-10-03 04:31:56 +00:00
### 👀 Review Process
1. Manually test the changes
2. At least one maintainer review required
3. Address all review comments
4. Maintain clean commit history
2024-10-03 04:24:22 +00:00
## Coding Standards
2024-10-03 04:24:22 +00:00
### 💻 General Guidelines
- Follow existing code style
- Comment complex logic
- Keep functions focused and small
- Use meaningful variable names
2024-10-03 04:24:22 +00:00
## Development Setup
2024-07-10 16:44:39 +00:00
### 🔄 Initial Setup
1. Clone the repository:
2024-07-10 16:44:39 +00:00
```bash
git clone https://github.com/coleam00/bolt.new-any-llm.git
2024-07-10 16:44:39 +00:00
```
2. Install dependencies:
```bash
2024-09-25 18:54:09 +00:00
pnpm install
```
3. Set up environment variables:
- Rename `.env.example` to `.env.local`
- Add your LLM API keys (only set the ones you plan to use):
```bash
GROQ_API_KEY=XXX
OPENAI_API_KEY=XXX
2024-09-25 18:54:09 +00:00
ANTHROPIC_API_KEY=XXX
...
2024-09-25 18:54:09 +00:00
```
- Optionally set debug level:
```bash
2024-09-25 18:54:09 +00:00
VITE_LOG_LEVEL=debug
```
**Important**: Never commit your `.env.local` file to version control. It's already included in .gitignore.
### 🚀 Running the Development Server
2024-07-29 18:31:45 +00:00
```bash
2024-09-25 18:54:09 +00:00
pnpm run dev
2024-07-29 18:31:45 +00:00
```
**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.
2024-07-10 16:44:39 +00:00
2024-09-25 18:54:09 +00:00
## Testing
2024-07-10 16:44:39 +00:00
2024-09-25 18:54:09 +00:00
Run the test suite with:
2024-07-10 16:44:39 +00:00
```bash
2024-09-25 18:54:09 +00:00
pnpm test
2024-07-10 16:44:39 +00:00
```
2024-09-25 18:54:09 +00:00
## Deployment
To deploy the application to Cloudflare Pages:
2024-07-10 16:44:39 +00:00
```bash
2024-09-25 18:54:09 +00:00
pnpm run deploy
2024-07-10 16:44:39 +00:00
```
2024-09-25 18:54:09 +00:00
Make sure you have the necessary permissions and Wrangler is correctly configured for your Cloudflare account.
2024-10-06 14:12:49 +00:00
## 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
```