Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ali00209 committed Oct 24, 2024
1 parent e4e59b1 commit 829ee08
Showing 1 changed file with 55 additions and 41 deletions.
96 changes: 55 additions & 41 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,65 +2,67 @@

# Bolt.new Fork by Cole Medin

This enhanced fork of Bolt.new empowers you to choose from a variety of Language Models (LLMs) for each prompt, including OpenAI, Anthropic, Ollama, OpenRouter, Gemini, and Groq. The architecture is designed for easy extension to support any model compatible with the Vercel AI SDK. Detailed instructions for local setup and model integration are provided below.
This fork of Bolt.new allows you to choose the LLM that you use for each prompt! Currently, you can use OpenAI, Anthropic, Ollama, OpenRouter, Gemini, or Groq models - and it is easily extended to use any other model supported by the Vercel AI SDK! See the instructions below for running this locally and extending it to include more models.

## Completed Enhancements
# Requested Additions to this Fork - Feel Free to Contribute!!

- ✅ OpenRouter Integration (@coleam00)
- ✅ Gemini Integration (@jonathands)
- ✅ Automatic Ollama model detection (@yunatamos)
- ✅ Model filtering by provider (@jasonm23)
- ✅ Project download as ZIP (@fabwaseem)

## Roadmap - Contributions Welcome!

- ✅ Autogenerate Ollama models from what is downloaded (@yunatamos)
- ✅ Filter models by provider (@jasonm23)
- ✅ Download project as ZIP (@fabwaseem)
- ✅ Improvements to the main Bolt.new prompt in `app\lib\.server\llm\prompts.ts` (@kofi-bhr)
- ✅ DeepSeek API Integration (@zenith110)
- ✅ Mistral API Integration (@ArulGandhi)
- ✅ "Open AI Like" API Integration (@ZerxZ)
- ✅ Ability to sync files (one way sync) to local folder (@muzafferkadir)
- ✅ Containerize the application with Docker for easy installation (@aaronbolton)
- ✅ Publish projects directly to GitHub (@goncaloalves)
- ⬜ Prevent Bolt from rewriting files as often (Done but need to review PR still)
-**HIGH PRIORITY** - Better prompting for smaller LLMs (code window sometimes doesn't start)
-**HIGH PRIORITY** - Attach images to prompts
-**HIGH PRIORITY** - Run agents in the backend as opposed to a single model call
- ⬜ LM Studio Integration
- ⬜ DeepSeek API Integration
- ⬜ Together AI Integration
- ⬜ Azure OpenAI API Integration
- ⬜ Together Integration
- ⬜ Azure Open AI API Integration
- ⬜ HuggingFace Integration
- ⬜ Perplexity AI Integration
- ⬜ Docker containerization for simplified deployment
- ⬜ Optimized prompting for smaller LLMs
- ⬜ Image attachment support for prompts
- ⬜ Backend agent execution (replacing single model calls)
- ⬜ Direct GitHub project publishing
- ⬜ One-click deployment to Vercel/Netlify/similar platforms
- ⬜ Local project import functionality
- ⬜ Code version control and rollback feature
- ⬜ Prompt result caching for efficiency
- ⬜ In-UI API key management
- ⬜ Reduced frequency of file rewrites
- ⬜ Perplexity Integration
- ⬜ Deploy directly to Vercel/Netlify/other similar platforms
- ⬜ Load local projects into the app
- ⬜ Ability to revert code to earlier version
- ⬜ Prompt caching
- ⬜ Ability to enter API keys in the UI
- ⬜ Have LLM plan the project in a MD file for better results/transparency

# Bolt.new: Revolutionizing Full-Stack Web Development in the Browser
# Bolt.new: AI-Powered Full-Stack Web Development in the Browser

Bolt.new is a cutting-edge AI-powered web development platform that enables you to prompt, run, edit, and deploy full-stack applications directly from your browser, eliminating the need for local setup. For those interested in building their own AI-powered web development tools using the Bolt open-source codebase, [start here](./CONTRIBUTING.md).
Bolt.new 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)

## Bolt.new's Unique Advantages
## What Makes Bolt.new Different

While platforms like Claude and GPT-4 excel at code generation, Bolt.new takes it further by providing a complete development environment:
Claude, v0, etc are incredible- but you can't install packages, run backends, or edit code. That’s where Bolt.new stands out:

- **Comprehensive Browser-Based Development**: Bolt.new seamlessly integrates state-of-the-art AI models with an in-browser development environment powered by **StackBlitz's WebContainers**, enabling:
- Installation and execution of npm tools and libraries (e.g., Vite, Next.js)
- Node.js server runtime
- Third-party API integration
- Chat-based production deployment
- Shareable project URLs
- **Full-Stack in the Browser**: Bolt.new integrates cutting-edge AI models with an in-browser development environment powered by **StackBlitzs WebContainers**. This allows you to:
- Install and run npm tools and libraries (like Vite, Next.js, and more)
- Run Node.js servers
- Interact with third-party APIs
- Deploy to production from chat
- Share your work via a URL

- **AI-Driven Environment Control**: Unlike traditional IDEs where AI assists only in code generation, Bolt.new grants AI models **full control** over the entire development ecosystem, including the filesystem, Node.js server, package manager, terminal, and browser console. This empowers AI agents to manage the complete application lifecycle from inception to deployment.
- **AI with Environment Control**: Unlike traditional dev environments where the AI can only assist in code generation, Bolt.new gives AI models **complete control** over the entire environment including the filesystem, node server, package manager, terminal, and browser console. This empowers AI agents to handle the whole app lifecyclefrom creation to deployment.

Bolt.new caters to experienced developers, product managers, and designers alike, facilitating the creation of production-ready full-stack applications with ease.
Whether you’re an experienced developer, a PM, or a designer, Bolt.new allows you to easily build production-grade full-stack applications.

For developers keen on building their own AI-enhanced development tools using WebContainers, explore the open-source Bolt codebase in this repository!
For developers interested in building their own AI-powered development tools with WebContainers, check out the open-source Bolt codebase in this repo!

## Prerequisites

Ensure you have the following installed before proceeding:
Before you begin, ensure you have the following installed:

- Node.js (v20.15.1 or later)
- pnpm (v9.4.0 or later)
- Node.js (v20.15.1)
- pnpm (v9.4.0)

## Setup Instructions
## Setup

1. Clone the repository (if you haven't already):

Expand Down Expand Up @@ -117,4 +119,16 @@ To start the development server:
pnpm run dev
```

This will start the Remix Vite development server. You will need Google Chrome Canary to run this locally! It's an easy install and a good browser for web development anyway.
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.new:

- **Be specific about your stack**: If you want to use specific frameworks or libraries (like Astro, Tailwind, ShadCN, or any other popular JavaScript framework), mention them in your initial prompt to ensure Bolt scaffolds the project accordingly.

- **Use the enhance prompt icon**: Before sending your prompt, try clicking the 'enhance' icon to have the AI model help you refine your prompt, then edit the results before submitting.

- **Scaffold the basics first, then add features**: Make sure the basic structure of your application is in place before diving into more advanced functionality. This helps Bolt understand the foundation of your project and ensure everything is wired up right before building out more advanced functionality.

- **Batch simple instructions**: Save time by combining simple instructions into one message. For example, you can ask Bolt to change the color scheme, add mobile responsiveness, and restart the dev server, all in one go saving you time and reducing API credit consumption significantly.

0 comments on commit 829ee08

Please sign in to comment.