mirror of
https://github.com/coleam00/bolt.new-any-llm
synced 2024-12-27 22:33:03 +00:00
doc: mkdoc consistent style
used a consistent style throughout the mkdoc's when separating sections
This commit is contained in:
Dustin Loring
parent
02621e3545
commit
a053bfc96f
@ -8,10 +8,14 @@
|
||||
- [Development Setup](#development-setup)
|
||||
- [Deploymnt with Docker](#docker-deployment-documentation)
|
||||
|
||||
---
|
||||
|
||||
## 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
|
||||
@ -29,6 +33,8 @@ This project and everyone participating in it is governed by our Code of Conduct
|
||||
### ✨ 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).
|
||||
|
||||
---
|
||||
|
||||
## Pull Request Guidelines
|
||||
|
||||
### 📝 PR Checklist
|
||||
@ -43,6 +49,8 @@ We're looking for dedicated contributors to help maintain and grow this project.
|
||||
3. Address all review comments
|
||||
4. Maintain clean commit history
|
||||
|
||||
---
|
||||
|
||||
## Coding Standards
|
||||
|
||||
### 💻 General Guidelines
|
||||
@ -51,6 +59,8 @@ We're looking for dedicated contributors to help maintain and grow this project.
|
||||
- Keep functions focused and small
|
||||
- Use meaningful variable names
|
||||
|
||||
---
|
||||
|
||||
## Development Setup
|
||||
|
||||
### 🔄 Initial Setup
|
||||
@ -100,6 +110,8 @@ 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:
|
||||
@ -108,6 +120,8 @@ Run the test suite with:
|
||||
pnpm test
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Deployment
|
||||
|
||||
To deploy the application to Cloudflare Pages:
|
||||
@ -118,6 +132,8 @@ pnpm run deploy
|
||||
|
||||
Make sure you have the necessary permissions and Wrangler is correctly configured for your Cloudflare account.
|
||||
|
||||
---
|
||||
|
||||
# Docker Deployment Documentation
|
||||
|
||||
This guide outlines various methods for building and deploying the application using Docker.
|
||||
@ -172,6 +188,8 @@ docker run -p 5173:5173 --env-file .env.local bolt-ai:development
|
||||
docker run -p 5173:5173 --env-file .env.local bolt-ai:production
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Deployment with Coolify
|
||||
|
||||
[Coolify](https://github.com/coollabsio/coolify) provides a straightforward deployment process:
|
||||
@ -189,6 +207,8 @@ docker run -p 5173:5173 --env-file .env.local bolt-ai:production
|
||||
- Adjust other environment variables as needed
|
||||
7. Deploy the application
|
||||
|
||||
---
|
||||
|
||||
## VS Code Integration
|
||||
|
||||
The `docker-compose.yaml` configuration is compatible with VS Code dev containers:
|
||||
@ -197,6 +217,8 @@ The `docker-compose.yaml` configuration is compatible with VS Code dev container
|
||||
2. Select the dev container configuration
|
||||
3. Choose the "development" profile from the context menu
|
||||
|
||||
---
|
||||
|
||||
## Environment Files
|
||||
|
||||
Ensure you have the appropriate `.env.local` file configured before running the containers. This file should contain:
|
||||
@ -204,12 +226,16 @@ Ensure you have the appropriate `.env.local` file configured before running the
|
||||
- Environment-specific configurations
|
||||
- Other required environment variables
|
||||
|
||||
---
|
||||
|
||||
## DEFAULT_NUM_CTX
|
||||
|
||||
The `DEFAULT_NUM_CTX` environment variable can be used to limit the maximum number of context values used by the qwen2.5-coder model. For example, to limit the context to 24576 values (which uses 32GB of VRAM), set `DEFAULT_NUM_CTX=24576` in your `.env.local` file.
|
||||
|
||||
First off, thank you for considering contributing to bolt.diy! This fork aims to expand the capabilities of the original project by integrating multiple LLM providers and enhancing functionality. Every contribution helps make bolt.diy a better tool for developers worldwide.
|
||||
|
||||
---
|
||||
|
||||
## Notes
|
||||
|
||||
- Port 5173 is exposed and mapped for both development and production environments
|
||||
|
||||
@ -9,6 +9,8 @@ https://thinktank.ottomator.ai
|
||||
|
||||
bolt.diy is an AI-powered web development agent that allows you to prompt, run, edit, and deploy full-stack applications directly from your browser—no local setup required. If you're here to build your own AI-powered web dev agent using the Bolt open source codebase, [click here to get started!](./CONTRIBUTING.md)
|
||||
|
||||
---
|
||||
|
||||
## What Makes bolt.diy Different
|
||||
|
||||
Claude, v0, etc are incredible- but you can't install packages, run backends, or edit code. That’s where bolt.diy stands out:
|
||||
@ -26,6 +28,8 @@ Whether you’re an experienced developer, a PM, or a designer, bolt.diy allows
|
||||
|
||||
For developers interested in building their own AI-powered development tools with WebContainers, check out the open-source Bolt codebase in this repo!
|
||||
|
||||
---
|
||||
|
||||
## Setup
|
||||
|
||||
Many of you are new users to installing software from Github. If you have any installation troubles reach out and submit an "issue" using the links above, or feel free to enhance this documentation by forking, editing the instructions, and doing a pull request.
|
||||
@ -128,6 +132,8 @@ When you run the Docker Compose command with the development profile, any change
|
||||
make on your machine to the code will automatically be reflected in the site running
|
||||
on the container (i.e. hot reloading still applies!).
|
||||
|
||||
---
|
||||
|
||||
## Run Without Docker
|
||||
|
||||
1. Install dependencies using Terminal (or CMD in Windows with admin permissions):
|
||||
@ -148,6 +154,8 @@ sudo npm install -g pnpm
|
||||
pnpm run dev
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Adding New LLMs:
|
||||
|
||||
To make new LLMs available to use in this version of bolt.diy, head on over to `app/utils/constants.ts` and find the constant MODEL_LIST. Each element in this array is an object that has the model ID for the name (get this from the provider's API documentation), a label for the frontend model dropdown, and the provider.
|
||||
@ -156,6 +164,8 @@ By default, Anthropic, OpenAI, Groq, and Ollama are implemented as providers, bu
|
||||
|
||||
When you add a new model to the MODEL_LIST array, it will immediately be available to use when you run the app locally or reload it. For Ollama models, make sure you have the model installed already before trying to use it here!
|
||||
|
||||
---
|
||||
|
||||
## Available Scripts
|
||||
|
||||
- `pnpm run dev`: Starts the development server.
|
||||
@ -167,6 +177,8 @@ When you add a new model to the MODEL_LIST array, it will immediately be availab
|
||||
- `pnpm run typegen`: Generates TypeScript types using Wrangler.
|
||||
- `pnpm run deploy`: Builds the project and deploys it to Cloudflare Pages.
|
||||
|
||||
---
|
||||
|
||||
## Development
|
||||
|
||||
To start the development server:
|
||||
@ -177,6 +189,8 @@ pnpm run dev
|
||||
|
||||
This will start the Remix Vite development server. 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.
|
||||
|
||||
---
|
||||
|
||||
## Tips and Tricks
|
||||
|
||||
Here are some tips to get the most out of bolt.diy:
|
||||
|
||||
Loading…
Reference in New Issue
Block a user