Update README for the 0.1

commit: 2b2083b8766af20b7410827d4e455f588953ad2c
author: bnema · 2y ago · 2023-11-08 17:53 UTC
committer: bnema · 2y ago · 2023-11-08 22:40 UTC
parent: 750013f
signature: unsigned

1 file · +29 -13

M README.md +29 -13


@@ -13,29 +13,45 @@ Gordon is a tool written in Go that aims to simplify the deployment of your cont
13	13
14	14		## Key Features
15	15
16		-	- Quick Deployment: Deploy container images effortlessly using the command `gordon deploy <image:version> -p 8080:80 -t gordon.sld.tld`
17		-	- Self-Hosted: Operates within your existing self-hosted environment.
	16	+	- Ease of use: Deploy container images effortlessly using the command `gordon deploy`.
	17	+	- Self-Hosted: Operates within your existing self-hosted environment and don't interfere with your existing setup.
18	18		- Web UI: Provides a simple web UI to manage your deployments, domains, exposed ports, and more.
19	19		- Automated Routing: Collaborates with Traefik to automatically route your application to your desired domain or subdomain.
20	20		- One binary: Gordon follows the Golang philosophy of keeping things simple, offering a single binary for all functionalities.
21		-	- Minimal stack: Sqlite3 is used as in memory database (no ORM), the web UI is built using Go templates, HTMX and Tailwind CSS
	21	+	- Minimal stack: Sqlite3 (no ORM) for the db, the web UI is built using Go templates, HTMX and Tailwind CSS
	22	+	- Simple authentication: Use Github OAuth to authenticate with the web UI and a token for the CLI.
	23	+
	24	+	![Demo Deploy](assets/vhs/demo_deploy.gif?raw=true)
	25	+
22	26
23	27		## Why ?
24	28
25		-	I found myself spending excessive time manually deploying my containerized applications using remote SSH. Being a lazy developer, I wanted a tool that would automate this process. However, I couldn't find one that met my requirements (dead simple), so I decided to make my own.
	29	+	I found myself spending excessive time manually deploying my containerized applications via remote SSH. I needed a tool that would automate the process to quickly spin up my test environments, and since I was eager to learn Go, I decided to create it myself.
	30	+
	31	+	## Installation / Getting Started / Usage
	32	+
	33	+	For detailed instructions, please refer to the wiki: <https://github.com/bnema/gordon/wiki/>
	34	+
	35	+
	36	+	## Development Status & Disclaimer
	37	+
	38	+	🛠️ Note: Gordon is under heavy development and is absolutely not ready for production. Thank you in advance for taking the time to test it and report any issues you may encounter.
26	39
27		-	## Development Status
	40	+	I also want to emphasize that I am far from being a Go expert yet. Hence, if you notice any poor practices, I welcome your feedback—respectfully, of course. It's a valuable part of the learning process!
28	41
29		-	🛠️ Note: This project is currently under heavy development. A 0.1 release with basic features will be available soon.
	42	+	## Roadmap beyond 0.1
30	43
31		-	## TODO for 0.1 release
	44	+	- Bug fixes (obviously)
	45	+	- Add tests
	46	+	- Better error handling and logging
	47	+	- Sexier WebUI with more features while keeping it simple (spa)
	48	+	- Sexier CLI (<3 [Charm](https://github.com/charmbracelet))
	49	+	- Refined CLI to backend authentication process (utilizing GitHub OAuth Device flow)
	50	+	- `deploy` command with no params
	51	+	- `push` command
	52	+	- Templates for databases (mysql, postgresql, redis, etc.)
32	53
33		-	- [x] Basic web UI for managing deployments
34		-	- [x] CRUD operations with the container engine
35		-	- [x] Improve authentication security
36		-	- [x] Interaction with the database
37		-	- [ ] New version update mechanism (backup, rollback etc.)
38		-	- [ ] Basic CLI to push images to the container engine
	54	+	Have suggestions? Feel free to open an issue!
39	55
40	56		## License
41	57

 ## **Key Features**
-- **Quick Deployment**: Deploy container images effortlessly using the command **`gordon deploy <image:version> -p 8080:80 -t gordon.sld.tld`**
+- **Ease of use**: Deploy container images effortlessly using the command **`gordon deploy`**.
-- **Self-Hosted**: Operates within your existing self-hosted environment.
+- **Self-Hosted**: Operates within your existing self-hosted environment and don't interfere with your existing setup.
 - **Web UI**: Provides a simple web UI to manage your deployments, domains, exposed ports, and more.
 - **Automated Routing**: Collaborates with Traefik to automatically route your application to your desired domain or subdomain.
 - **One binary**: Gordon follows the Golang philosophy of keeping things simple, offering a single binary for all functionalities.
-- **Minimal stack**: Sqlite3 is used as in memory database (no ORM), the web UI is built using Go templates, HTMX and Tailwind CSS
+- **Minimal stack**: Sqlite3 (no ORM) for the db, the web UI is built using Go templates, HTMX and Tailwind CSS
+- **Simple authentication**: Use Github OAuth to authenticate with the web UI and a token for the CLI.
+![Demo Deploy](assets/vhs/demo_deploy.gif?raw=true)
 ## **Why ?**
-I found myself spending excessive time manually deploying my containerized applications using remote SSH. Being a lazy developer, I wanted a tool that would automate this process. However, I couldn't find one that met my requirements (dead simple), so I decided to make my own.
+I found myself spending excessive time manually deploying my containerized applications via remote SSH. I needed a tool that would automate the process to quickly spin up my test environments, and since I was eager to learn Go, I decided to create it myself.
+## **Installation / Getting Started / Usage**
+For detailed instructions, please refer to the wiki:  <https://github.com/bnema/gordon/wiki/>
+## **Development Status & Disclaimer**
+🛠️ **Note**: Gordon is under heavy development and is absolutely not ready for production. Thank you in advance for taking the time to test it and report any issues you may encounter.
-## **Development Status**
+I also want to emphasize that I am far from being a Go expert yet. Hence, if you notice any poor practices, I welcome your feedback—respectfully, of course. It's a valuable part of the learning process!
-🛠️ **Note**: This project is currently under heavy development. A 0.1 release with basic features will be available soon.
+## **Roadmap beyond 0.1**
-## **TODO for 0.1 release**
+- Bug fixes (obviously)
+- Add tests
+- Better error handling and logging
+- Sexier WebUI with more features while keeping it simple (spa)
+- Sexier CLI (<3 [Charm](https://github.com/charmbracelet))
+- Refined CLI to backend authentication process (utilizing GitHub OAuth Device flow)
+- `deploy` command with no params
+- `push` command
+- Templates for databases (mysql, postgresql, redis, etc.)
-- [x] Basic web UI for managing deployments
+Have suggestions? Feel free to open an issue!
-- [x] CRUD operations with the container engine
-- [x] Improve authentication security
-- [x] Interaction with the database
-- [ ] New version update mechanism (backup, rollback etc.)
-- [ ] Basic CLI to push images to the container engine
 ## **License**