This commit is contained in:
		
							
								
								
									
										20
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										20
									
								
								README.md
									
									
									
									
									
								
							| @ -2,6 +2,26 @@ | ||||
|  | ||||
| Astroad is a pre-configured setup for Astro and Payloadcms, designed to make it easy for you to start building your website. With Astroad, you'll have a complete development environment that you can run locally using Docker. This setup simplifies the testing and development of your website before deploying it to a production environment. | ||||
|  | ||||
| ## Important notes | ||||
| ### Adding dependencies | ||||
| 1. When adding a dedpendency to astro or payload, you must regenerate the yarn.lock file for the dev server toinstall the dependencies. | ||||
| 2. Regenerate the lock file: | ||||
| `cd astro` or `cd payload` | ||||
| `rm yarn.lock` | ||||
| `yarn install` | ||||
| 3. Restart dev server `yarn dev` | ||||
|  | ||||
| ## Dev server getting stuck | ||||
| Sometimes the dev script gets stuck, for an unknown reason: | ||||
| ``` | ||||
| [+] Running 3/0 | ||||
|  ✔ Container astroad-mongo    Running                                                                                                                    0.0s  | ||||
|  ✔ Container astroad-payload  Running                                                                                                                    0.0s  | ||||
|  ✔ Container astroad-astro    Running     | ||||
| ``` | ||||
|  | ||||
| Running `yarn stop` and then `yarn dev` should resolve the issue. | ||||
|  | ||||
| ## Prerequisites | ||||
|  | ||||
| Before getting started with Astroad, make sure you have the necessary software installed: | ||||
|  | ||||
		Reference in New Issue
	
	Block a user