From 8b870993023ffbc5b8a3b08a4c6d03403825cc41 Mon Sep 17 00:00:00 2001 From: Muthu Kumar Date: Wed, 22 Nov 2017 03:38:18 +0530 Subject: [PATCH 1/7] Create Contributors.md --- docs/Contributors.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 docs/Contributors.md diff --git a/docs/Contributors.md b/docs/Contributors.md new file mode 100644 index 0000000..33053da --- /dev/null +++ b/docs/Contributors.md @@ -0,0 +1,15 @@ +# Contributors, Collaborators, and Guides + +I'd like to thank and give credit to [The Devs Community](https://thedevs.network), who are the primary reason this exists. + +Plenty of people gave their time guiding me and shaping this tool. I'd personally thank the following amazing people for their valuable support and feedback: + +- Pouria Ezzati (https://github.com/poeti8) +- Thomas Rory Gummerson (https://github.com/trgwii) +- Omar Khalil (https://github.com/DonMcCoy) +- Martin (https://gitlab.com/C0rn3j) +- GingerPlusPlus (https://github.com/GingerPlusPlus) +- Faizan Akram (https://github.com/faizanakram99) +- Chris Watson (https://github.com/watzon) + +And many many people who did not directly contribute but managed to keep listening to my crazy ideas (and motivating) towards the beginning of this project. From 8ee1859dd21384b47b8db84ae4cbdbfb55ef0db7 Mon Sep 17 00:00:00 2001 From: Muthu Kumar Date: Wed, 22 Nov 2017 03:47:39 +0530 Subject: [PATCH 2/7] Update and rename Contributing.MD to docs/Contributing.MD --- Contributing.MD | 31 ------------------------------- docs/Contributing.MD | 31 +++++++++++++++++++++++++++++++ 2 files changed, 31 insertions(+), 31 deletions(-) delete mode 100644 Contributing.MD create mode 100644 docs/Contributing.MD diff --git a/Contributing.MD b/Contributing.MD deleted file mode 100644 index fd1cebd..0000000 --- a/Contributing.MD +++ /dev/null @@ -1,31 +0,0 @@ -# How to contribute - -First of all, thank you for taking the time to contribute to this project. We've tried to make a stable project and try to fix bugs and add new features continuously. You can help us do more. - -## Getting started - -### Check out the roadmap - -We have some functionalities in mind and we have issued them and there is a milestone label available on the issue. If there is a bug or a feature that is not listed in the issues page or there is no one assigned to the issue, feel free to fix/add it! Although it's better to discuss it in the issue or create a new issue for it so there is no confilcting code. - -### Writing some code! - -Contributing to a project on Github is pretty straight forward. If this is you're first time, these are the steps you should take. - -- Fork this repo. - -And that's it! Read the code available and change the part you don't like! You're change should not break the existing code and should pass the tests. We recommend using VS Code while working on this project. - -If you're adding a new functionality, start from the branch master. It would be a better practice to create a new branch and work in there. - -When you're done, submit a pull request and for one of the maintainers to check it out. We would let you know if there is any problem or any changes that should be considered. - -### Tests - -We haven't written tests yet and you can manually try commands and assure the stability of the code. If you're adding a new test please write documentation for it by creating Tests.MD. - -### Documentation - -Every chunk of code that may be hard to understand has some comments above it. If you write some new code or change some part of the existing code in a way that it would not be functional without changing it's usages, it needs to be documented. - -**__Overall, just have fun, and make sure nothing breaks. Thanks!__** \ No newline at end of file diff --git a/docs/Contributing.MD b/docs/Contributing.MD new file mode 100644 index 0000000..20e9248 --- /dev/null +++ b/docs/Contributing.MD @@ -0,0 +1,31 @@ +# How to contribute + +First of all, thank you for taking the time to contribute to this project. We've tried to make a stable project and try to fix bugs and add new features continuously. You can help us do more. + +## Getting started + +### Check out the roadmap + +We have some functionalities in mind and we have issued them and there is a milestone label available on the issue. If there is a bug or a feature that is not listed in the issues page or there is no one assigned to the issue, feel free to fix/add it! Although it's better to discuss it in the issue or create a new issue for it so there is no confilcting code. + +### Writing some code! + +Contributing to a project on Github is pretty straight forward. If this is you're first time, these are the steps you should take. + +- Fork this repo. + +And that's it! Read the code available and change the part you don't like! Your change should not break any existing functionality and should work as promised. If you're having trouble with it, mention it. We recommend using VS Code while working on this project. + +If you're adding a new functionality, start from the branch develop. It would be a better practice to create a new branch and work in there. + +When you're done, submit a pull request and for one of the maintainers to check it out. We would let you know if there is any problem or any changes that should be considered. + +### Tests + +We haven't written tests yet and you can manually try commands and assure the stability of the code. If you're adding a new test please write documentation for it by creating /docs/Tests.MD. + +### Documentation + +Every chunk of code that may be hard to understand has some comments above it. If you write some new code or change some part of the existing code in a way that it would not be functional without changing it's usages, it needs to be documented. + +**__Overall, just have fun, and make sure nothing breaks. Thanks!__** From 4e524185b6c4a89ae158ba76d84678b42bfa4087 Mon Sep 17 00:00:00 2001 From: Muthu Kumar Date: Wed, 22 Nov 2017 03:50:47 +0530 Subject: [PATCH 3/7] Update to changelog --- Changelog.md | 13 ------------- docs/Changelog.md | 15 +++++++++++++++ 2 files changed, 15 insertions(+), 13 deletions(-) delete mode 100644 Changelog.md create mode 100644 docs/Changelog.md diff --git a/Changelog.md b/Changelog.md deleted file mode 100644 index 0925284..0000000 --- a/Changelog.md +++ /dev/null @@ -1,13 +0,0 @@ -# Changelog / Version history - -## `up` v. 0.2.0 - -Changelog: - -- Under the hood BREAKING changes. Working directories change. - - `/var/www/` to `/etc/up-serve/static/` - - `/etc/nginx/sites-available/` to `/etc/nginx/conf.d` -- `up static|proxy ` adds the server to `/etc/up-serve/servers.up` list. -- `up kill ` removes server from `servers.up` list. -- `up list` lists available servers from /etc/up-serve/servers.up! -- `up kill-all` destroys all servers and places a `default.conf` in `/etc/nginx/sites-enabled`. \ No newline at end of file diff --git a/docs/Changelog.md b/docs/Changelog.md new file mode 100644 index 0000000..b6529cf --- /dev/null +++ b/docs/Changelog.md @@ -0,0 +1,15 @@ +# Changelog / Version history + +## `up` v. 0.2.1 + +- Bug fix and patch for `up kill-all` breaking unexpectedly due to undefined default config file. + +## `up` v. 0.2.0 + +- Under the hood BREAKING changes. Working directories change. + - `/var/www/` to `/etc/up-serve/static/` + - `/etc/nginx/sites-available/` to `/etc/nginx/conf.d` +- `up static|proxy ` adds the server to `/etc/up-serve/servers.up` list. +- `up kill ` removes server from `servers.up` list. +- `up list` lists available servers from /etc/up-serve/servers.up! +- `up kill-all` destroys all servers and places a `default.conf` in `/etc/nginx/sites-enabled`. From 0b24257cd4196ba310bfd58f4f4c954d26356446 Mon Sep 17 00:00:00 2001 From: Muthu Kumar Date: Wed, 22 Nov 2017 03:53:30 +0530 Subject: [PATCH 4/7] Moved to docs --- Roadmap.md | 33 --------------------------------- docs/Roadmap.md | 33 +++++++++++++++++++++++++++++++++ 2 files changed, 33 insertions(+), 33 deletions(-) delete mode 100644 Roadmap.md create mode 100644 docs/Roadmap.md diff --git a/Roadmap.md b/Roadmap.md deleted file mode 100644 index 5e497f9..0000000 --- a/Roadmap.md +++ /dev/null @@ -1,33 +0,0 @@ -# Roadmap - -This living document details our plans for `up`. If you would like to request features or move something up the roadmap, raise an issue! - -> ⚠️ ❌ Disclaimers: There is NO guarantee that these will be executed in this order, or if at all. If they are executed, there is NO guarantee that they will follow the same syntax as shown in examples below. For the right syntax, check [README.md](README.md) - -> The words `MUST`, `MUST NOT`, `SHOULD`, `SHOULD NOT`, and `MAY` are used in accordance with [RFC 2119](https://tools.ietf.org/html/rfc2119) - -## The Roadmap - -- [x] MVP - Minimum Viable Product. - - [x] `up static` and `up proxy` MUST work. - - [x] `up kill` MUST work. -- [x]List servers option. - - [x] `up list` MUST provide list of servers running from `/etc/up-serve/servers.up` file. -- [x] `up static` MUST have an option to specify path to root. Example: `up static example.com ./public`. -- [ ] `up static` and `up proxy` MAY take a Git URL to deploy. Example: - 1. `up static example.com --git https://github.com/h5bp/html5-boilerplate /html` - 2. `up proxy example.com 5000 --git https://github.com/heroku/node-js-sample` -- [ ] Option for HTTPS. - - [ ] MUST add a `-s` or `--secure` flag to enable automatic HTTPS config with HTTP/2 enabled by default. - - [ ] HSTS MAY be enabled with a `-s -h`, `-sh`, `-secure -hsts` or `--secure-hsts` flag. Will warn user to be sure of what they are doing. - - [ ] MAY add a `-c` flag to use `certbot` to automatically generate certificates using letsencrypt. -- [ ] MAY make `up` work on Windows. - -Want more features or prioritize something? Raise an [issue!](https://github.com/codefeathers/up-serve/issues) - -## Stretch goals - -- ♦ Create an `up` client to deploy from anywhere -- ♦ Make `up` an initialization tool that combines `git init`, `npm init`, `vue init`, etc. in a neat package. Examples: - 1. `up new git` - 2. `up new vue proxy 4000` \ No newline at end of file diff --git a/docs/Roadmap.md b/docs/Roadmap.md new file mode 100644 index 0000000..c05d26f --- /dev/null +++ b/docs/Roadmap.md @@ -0,0 +1,33 @@ +# Roadmap + +This living document details our plans for `up`. If you would like to request features or move something up the roadmap, raise an issue! + +> ⚠️ ❌ Disclaimers: There is NO guarantee that these will be executed in this order, or if at all. If they are executed, there is NO guarantee that they will follow the same syntax as shown in examples below. For the right syntax, check [README.md](README.md) + +> The words `MUST`, `MUST NOT`, `SHOULD`, `SHOULD NOT`, and `MAY` are used in accordance with [RFC 2119](https://tools.ietf.org/html/rfc2119) + +## The Roadmap + +- [x] MVP - Minimum Viable Product. + - [x] `up static` and `up proxy` MUST work. + - [x] `up kill` MUST work. +- [x]List servers option. + - [x] `up list` MUST provide list of servers running from `/etc/up-serve/servers.up` file. +- [ ] `up static` MUST have an option to specify path to root. Example: `up static example.com ./public`. +- [ ] `up static` and `up proxy` MAY take a Git URL to deploy. Example: + 1. `up static example.com --git https://github.com/h5bp/html5-boilerplate /html` + 2. `up proxy example.com 5000 --git https://github.com/heroku/node-js-sample` +- [ ] Option for HTTPS. + - [ ] MUST add a `-s` or `--secure` flag to enable automatic HTTPS config with HTTP/2 enabled by default. + - [ ] HSTS MAY be enabled with a `-s -h`, `-sh`, `-secure -hsts` or `--secure-hsts` flag. Will warn user to be sure of what they are doing. + - [ ] MAY add a `-c` flag to use `certbot` or `acme.sh` to automatically generate certificates using letsencrypt. +- [ ] MAY make `up` work on Windows. + +Want more features or prioritize something? Raise an [issue!](https://github.com/codefeathers/up-serve/issues) + +## Stretch goals + +- ♦ Create an `up` client to deploy from anywhere +- ♦ Make `up` an initialization tool that combines `git init`, `npm init`, `vue init`, etc. in a neat package. Examples: + 1. `up new git` + 2. `up new vue proxy 4000` From 9e91377fd4c64d96f8430a03d33c59260fad8522 Mon Sep 17 00:00:00 2001 From: Muthu Kumar Date: Wed, 22 Nov 2017 03:54:44 +0530 Subject: [PATCH 5/7] Fixed typo --- docs/Roadmap.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Roadmap.md b/docs/Roadmap.md index c05d26f..ca93d6c 100644 --- a/docs/Roadmap.md +++ b/docs/Roadmap.md @@ -11,7 +11,7 @@ This living document details our plans for `up`. If you would like to request fe - [x] MVP - Minimum Viable Product. - [x] `up static` and `up proxy` MUST work. - [x] `up kill` MUST work. -- [x]List servers option. +- [x] List servers option. - [x] `up list` MUST provide list of servers running from `/etc/up-serve/servers.up` file. - [ ] `up static` MUST have an option to specify path to root. Example: `up static example.com ./public`. - [ ] `up static` and `up proxy` MAY take a Git URL to deploy. Example: From 6491229c8952bc8b9f911a73a551c4b8a0b7972a Mon Sep 17 00:00:00 2001 From: Muthu Kumar Date: Wed, 22 Nov 2017 03:57:36 +0530 Subject: [PATCH 6/7] Update README.md --- README.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 128d3aa..17df013 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ > Current version: `up v.0.2.1 (Alpha)` -> Notes: `up` is now in Alpha! 🎉 [(Changelog)](Changelog.md)\ +> Notes: `up` is now in Alpha! 🎉 [(Changelog)](/docs/Changelog.md)\ > ⚠️ ❌ `up` is pretty useable so far. If you're testing `up` on a development server, do give us feedback. **`up`** is a command line application that creates nginx server blocks quickly with a single command. @@ -43,12 +43,10 @@ Format: `up command [optional]` - `up proxy example.com 8081` will create a reverse proxy listening at port 8081. - `up kill example.com` -## Contributors, Collaborators, and Guides +--- -Plenty of people gave their time guiding me and shaping this tool. +

Roadmap

-I'd like to thank and give credit to [The Devs Community](https://thedevs.network), who are the primary reason this exists. +

Contribution Guidelines

-I'd also personally thank the following amazing people for their valuable support and feedback: **Pouria Ezzati, Thomas Rory Gummerson, Omar Khalil, Martin, GingerPlusPlus, Faizan Akram.** - -And the following people for their moral support and listening to my constant bickering: **David (The Humanoid), Иброхеем, Simon 'SitiSchu' Schürrle.** +

Contributors, Collaborators, and Guides

From 0313c0bd3beb4cc3098dea5304358ce723cf9059 Mon Sep 17 00:00:00 2001 From: Muthu Kumar Date: Wed, 22 Nov 2017 04:03:56 +0530 Subject: [PATCH 7/7] Rename docs/Contributing.MD to Contributing.MD --- Contributing.MD | 31 +++++++++++++++++++++++++++++++ docs/Contributing.MD | 31 ------------------------------- 2 files changed, 31 insertions(+), 31 deletions(-) create mode 100644 Contributing.MD delete mode 100644 docs/Contributing.MD diff --git a/Contributing.MD b/Contributing.MD new file mode 100644 index 0000000..20e9248 --- /dev/null +++ b/Contributing.MD @@ -0,0 +1,31 @@ +# How to contribute + +First of all, thank you for taking the time to contribute to this project. We've tried to make a stable project and try to fix bugs and add new features continuously. You can help us do more. + +## Getting started + +### Check out the roadmap + +We have some functionalities in mind and we have issued them and there is a milestone label available on the issue. If there is a bug or a feature that is not listed in the issues page or there is no one assigned to the issue, feel free to fix/add it! Although it's better to discuss it in the issue or create a new issue for it so there is no confilcting code. + +### Writing some code! + +Contributing to a project on Github is pretty straight forward. If this is you're first time, these are the steps you should take. + +- Fork this repo. + +And that's it! Read the code available and change the part you don't like! Your change should not break any existing functionality and should work as promised. If you're having trouble with it, mention it. We recommend using VS Code while working on this project. + +If you're adding a new functionality, start from the branch develop. It would be a better practice to create a new branch and work in there. + +When you're done, submit a pull request and for one of the maintainers to check it out. We would let you know if there is any problem or any changes that should be considered. + +### Tests + +We haven't written tests yet and you can manually try commands and assure the stability of the code. If you're adding a new test please write documentation for it by creating /docs/Tests.MD. + +### Documentation + +Every chunk of code that may be hard to understand has some comments above it. If you write some new code or change some part of the existing code in a way that it would not be functional without changing it's usages, it needs to be documented. + +**__Overall, just have fun, and make sure nothing breaks. Thanks!__** diff --git a/docs/Contributing.MD b/docs/Contributing.MD deleted file mode 100644 index 20e9248..0000000 --- a/docs/Contributing.MD +++ /dev/null @@ -1,31 +0,0 @@ -# How to contribute - -First of all, thank you for taking the time to contribute to this project. We've tried to make a stable project and try to fix bugs and add new features continuously. You can help us do more. - -## Getting started - -### Check out the roadmap - -We have some functionalities in mind and we have issued them and there is a milestone label available on the issue. If there is a bug or a feature that is not listed in the issues page or there is no one assigned to the issue, feel free to fix/add it! Although it's better to discuss it in the issue or create a new issue for it so there is no confilcting code. - -### Writing some code! - -Contributing to a project on Github is pretty straight forward. If this is you're first time, these are the steps you should take. - -- Fork this repo. - -And that's it! Read the code available and change the part you don't like! Your change should not break any existing functionality and should work as promised. If you're having trouble with it, mention it. We recommend using VS Code while working on this project. - -If you're adding a new functionality, start from the branch develop. It would be a better practice to create a new branch and work in there. - -When you're done, submit a pull request and for one of the maintainers to check it out. We would let you know if there is any problem or any changes that should be considered. - -### Tests - -We haven't written tests yet and you can manually try commands and assure the stability of the code. If you're adding a new test please write documentation for it by creating /docs/Tests.MD. - -### Documentation - -Every chunk of code that may be hard to understand has some comments above it. If you write some new code or change some part of the existing code in a way that it would not be functional without changing it's usages, it needs to be documented. - -**__Overall, just have fun, and make sure nothing breaks. Thanks!__**