Add Gitpod configuration for quick setup of development environments
With this change, any developer can simply open a development environment in Gitpod. The environment has docs, web, and binary being built on every code change. Also included the vscode extensions for Go and Docker. Signed-off-by: Yarden Shoham <hrsi88@gmail.com>
This commit is contained in:
		
							parent
							
								
									8d3f35f4f7
								
							
						
					
					
						commit
						265af01f9c
					
				
					 3 changed files with 42 additions and 0 deletions
				
			
		
							
								
								
									
										28
									
								
								.gitpod.yml
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										28
									
								
								.gitpod.yml
									
										
									
									
									
										Normal file
									
								
							|  | @ -0,0 +1,28 @@ | ||||||
|  | tasks: | ||||||
|  |   - name: docs | ||||||
|  |     before: make docs-deps | ||||||
|  |     command: mkdocs serve | ||||||
|  |   - name: binary | ||||||
|  |     before: | | ||||||
|  |       npm install --global nodemon | ||||||
|  |       make cli-deps-static-sites | ||||||
|  |     command: | | ||||||
|  |       nodemon --watch './**/*.go' --ext go --signal SIGTERM --exec "CGO_ENABLED=1 go run main.go serve --listen-http :2586 --debug --base-url $(gp url 2586)" | ||||||
|  |     openMode: split-right | ||||||
|  |   - name: web | ||||||
|  |     before: make web-deps | ||||||
|  |     command: cd web && npm start | ||||||
|  |     openMode: split-right | ||||||
|  | 
 | ||||||
|  | vscode: | ||||||
|  |   extensions: | ||||||
|  |     - golang.go | ||||||
|  |     - ms-azuretools.vscode-docker | ||||||
|  | 
 | ||||||
|  | ports: | ||||||
|  |   - name: docs | ||||||
|  |     port: 8000 | ||||||
|  |   - name: binary | ||||||
|  |     port: 2586 | ||||||
|  |   - name: web | ||||||
|  |     port: 3000 | ||||||
|  | @ -11,6 +11,8 @@ | ||||||
| [](https://matrix.to/#/#ntfy-space:matrix.org) | [](https://matrix.to/#/#ntfy-space:matrix.org) | ||||||
| [](https://www.reddit.com/r/ntfy/) | [](https://www.reddit.com/r/ntfy/) | ||||||
| [](https://ntfy.statuspage.io/) | [](https://ntfy.statuspage.io/) | ||||||
|  | [](https://gitpod.io/#https://github.com/binwiederhier/ntfy) | ||||||
|  | 
 | ||||||
| 
 | 
 | ||||||
| **ntfy** (pronounce: *notify*) is a simple HTTP-based [pub-sub](https://en.wikipedia.org/wiki/Publish%E2%80%93subscribe_pattern) notification service. | **ntfy** (pronounce: *notify*) is a simple HTTP-based [pub-sub](https://en.wikipedia.org/wiki/Publish%E2%80%93subscribe_pattern) notification service. | ||||||
| It allows you to **send notifications to your phone or desktop via scripts** from any computer, entirely **without signup or cost**. | It allows you to **send notifications to your phone or desktop via scripts** from any computer, entirely **without signup or cost**. | ||||||
|  | @ -59,6 +61,12 @@ Or, if you'd like to help translate 🇩🇪 🇺🇸 🇧🇬, you can start im | ||||||
| <img src="https://hosted.weblate.org/widgets/ntfy/-/multi-blue.svg" alt="Translation status" /> | <img src="https://hosted.weblate.org/widgets/ntfy/-/multi-blue.svg" alt="Translation status" /> | ||||||
| </a> | </a> | ||||||
| 
 | 
 | ||||||
|  | ### Quickly getting a development environment setup | ||||||
|  | 
 | ||||||
|  | To get a quick working development environment you could use Gitpod. | ||||||
|  | 
 | ||||||
|  | [](https://gitpod.io/#https://github.com/binwiederhier/ntfy) | ||||||
|  | 
 | ||||||
| ## Sponsors | ## Sponsors | ||||||
| I have just very recently started accepting donations via [GitHub Sponsors](https://github.com/sponsors/binwiederhier).  | I have just very recently started accepting donations via [GitHub Sponsors](https://github.com/sponsors/binwiederhier).  | ||||||
| I would be humbled if you helped me carry the server and developer account costs. Even small donations are very much  | I would be humbled if you helped me carry the server and developer account costs. Even small donations are very much  | ||||||
|  |  | ||||||
|  | @ -22,6 +22,12 @@ server consists of three components: | ||||||
| 
 | 
 | ||||||
| All of these components are built and then **baked into one binary**.  | All of these components are built and then **baked into one binary**.  | ||||||
| 
 | 
 | ||||||
|  | ### Quickly getting a development environment setup | ||||||
|  | 
 | ||||||
|  | To get a quick working development environment you could use Gitpod. | ||||||
|  | 
 | ||||||
|  | [](https://gitpod.io/#https://github.com/binwiederhier/ntfy) | ||||||
|  | 
 | ||||||
| ### Navigating the code | ### Navigating the code | ||||||
| Code: | Code: | ||||||
| 
 | 
 | ||||||
|  |  | ||||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue