Cole Medin commited on
Commit
7fe66ae
·
1 Parent(s): a265d72

Fixing up setup + installation instructions in README

Browse files
Files changed (1) hide show
  1. README.md +70 -23
README.md CHANGED
@@ -61,20 +61,17 @@ Whether you’re an experienced developer, a PM, or a designer, Bolt.new allows
61
 
62
  For developers interested in building their own AI-powered development tools with WebContainers, check out the open-source Bolt codebase in this repo!
63
 
64
- ## Prerequisites
65
-
66
- Before you begin, ensure you have the following installed:
67
-
68
- - Node.js (v20.15.1)
69
- - pnpm (v9.4.0)
70
-
71
  ## Setup
72
 
73
- Many of you are new users to installing software from Github. Below are instructions for Mac users. PC users may be able to follow the instructions below as well. 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.
74
 
75
  1. Install Git from https://git-scm.com/downloads
76
 
77
- 2. Install Node.js from https://nodejs.org/en/download/. Pay attention to the installer notes after completion. On a Mac, it will tell you to check if /usr/local/bin is in your $PATH. To determine if usr/local/bin is included in $PATH open your Terminal and run
 
 
 
 
78
 
79
  ```
80
  echo $PATH .
@@ -88,19 +85,7 @@ If you see usr/local/bin in the output then you're good to go.
88
  git clone https://github.com/coleam00/bolt.new-any-llm.git
89
  ```
90
 
91
- 4. Install dependencies using Terminal (or CMD in Windows with admin permissions):
92
-
93
- ```
94
- pnpm install
95
- ```
96
-
97
- If you get an error saying "command not found: pnpm" or similar, then that means pnpm isn't installed. You can install it via this:
98
-
99
- ```
100
- sudo npm install -g pnpm
101
- ```
102
-
103
- 5. Rename .env.example to .env.local and add your LLM API keys. You will find this file on a Mac at "[your name]/bold.new-any-llm/.env.example"
104
 
105
  ![image](https://github.com/user-attachments/assets/7e6a532c-2268-401f-8310-e8d20c731328)
106
 
@@ -130,7 +115,69 @@ Optionally, you can set the debug level:
130
  VITE_LOG_LEVEL=debug
131
  ```
132
 
133
- **Important**: Never commit your `.env.local` file to version control. It's already included in .gitignore.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
134
 
135
  ## Adding New LLMs:
136
 
 
61
 
62
  For developers interested in building their own AI-powered development tools with WebContainers, check out the open-source Bolt codebase in this repo!
63
 
 
 
 
 
 
 
 
64
  ## Setup
65
 
66
+ 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.
67
 
68
  1. Install Git from https://git-scm.com/downloads
69
 
70
+ 2. Install Node.js from https://nodejs.org/en/download/
71
+
72
+ Pay attention to the installer notes after completion.
73
+
74
+ On all operating systems, the path to Node.js should automatically be added to your system path. But you can check your path if you want to be sure. On Windows, you can search for "edit the system environment variables" in your system, select "Environment Variables..." once you are in the system properties, and then check for a path to Node in your "Path" system variable. On a Mac or Linux machine, it will tell you to check if /usr/local/bin is in your $PATH. To determine if usr/local/bin is included in $PATH open your Terminal and run:
75
 
76
  ```
77
  echo $PATH .
 
85
  git clone https://github.com/coleam00/bolt.new-any-llm.git
86
  ```
87
 
88
+ 3. Rename .env.example to .env and add your LLM API keys. You will find this file on a Mac at "[your name]/bold.new-any-llm/.env.example". For Windows and Linux the path will be similar.
 
 
 
 
 
 
 
 
 
 
 
 
89
 
90
  ![image](https://github.com/user-attachments/assets/7e6a532c-2268-401f-8310-e8d20c731328)
91
 
 
115
  VITE_LOG_LEVEL=debug
116
  ```
117
 
118
+ **Important**: Never commit your `.env` file to version control. It's already included in .gitignore.
119
+
120
+ ## Run with Docker
121
+
122
+ Prerequisites:
123
+
124
+ Git and Node.js as mentioned above, as well as Docker: https://www.docker.com/
125
+
126
+ ### 1a. Using Helper Scripts
127
+
128
+ NPM scripts are provided for convenient building:
129
+
130
+ ```bash
131
+ # Development build
132
+ npm run dockerbuild
133
+
134
+ # Production build
135
+ npm run dockerbuild:prod
136
+ ```
137
+
138
+ ### 1b. Direct Docker Build Commands (alternative to using NPM scripts)
139
+
140
+ You can use Docker's target feature to specify the build environment instead of using NPM scripts if you wish:
141
+
142
+ ```bash
143
+ # Development build
144
+ docker build . --target bolt-ai-development
145
+
146
+ # Production build
147
+ docker build . --target bolt-ai-production
148
+ ```
149
+
150
+ ### 2. Docker Compose with Profiles to Run the Container
151
+
152
+ Use Docker Compose profiles to manage different environments:
153
+
154
+ ```bash
155
+ # Development environment
156
+ docker-compose --profile development up
157
+
158
+ # Production environment
159
+ docker-compose --profile production up
160
+ ```
161
+
162
+ ## Run Without Docker
163
+
164
+ 1. Install dependencies using Terminal (or CMD in Windows with admin permissions):
165
+
166
+ ```
167
+ pnpm install
168
+ ```
169
+
170
+ If you get an error saying "command not found: pnpm" or similar, then that means pnpm isn't installed. You can install it via this:
171
+
172
+ ```
173
+ sudo npm install -g pnpm
174
+ ```
175
+
176
+ 2. Start the application with the command:
177
+
178
+ ```bash
179
+ pnpm run dev
180
+ ```
181
 
182
  ## Adding New LLMs:
183