Skip to content
This repository has been archived by the owner on Jun 22, 2021. It is now read-only.

Commit

Permalink
README updates and prepare for 0.4.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
EvHaus committed May 27, 2019
1 parent 336801f commit 77185de
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 10 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## [0.4.0] - Unreleased
## [0.4.0] - 2019-05-26

### Added

Expand Down
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,28 +6,28 @@

## About

Services like [DigitalOcean](https://www.digitalocean.com/)'s droplets make it super easy to create deployment targets for websites and other Node.js projects. However, there are still a lot of manual steps developers have to do in order to get the servers setup, configured and ready to be used for production.
Services like [DigitalOcean](https://www.digitalocean.com/)'s droplets or [Linode](https://www.linode.com/)'s linodes make it super easy to create deployment targets for websites and other Node.js projects. However, there are still a lot of manual steps developers have to do in order to get the servers setup, configured and ready to be used for production.

The goal of this tool is to make all those deployment steps a single command. You should focus on developing the features of your project, and let this tool handle the server setup and deployment automation.

## Goals

These are the goals for this project:

- [ ] Installation & setup of target server
- [x] Install `node`
- [x] Install `yarn`
- [ ] Install `pm2`
- [ ] Install public SSH key
- [x] Automation of deployment
- [x] Installation & setup of target server
- [x] Install `node` or upgrade it to the latest version
- [x] Install `yarn` or upgrade it to the latest version
- [x] Install `pm2` or upgrade it to the latest version
- [x] Upgrade `apt-get` packages to ensure the latest security patches are installed
- [x] Automation of deployment steps
- [x] Create target directories on target server
- [x] Upload local project files to target server
- [x] Install/upgrade `node` dependencies on target server
- [x] Start/restart of services on target server
- [ ] Start the application if it's the first deployment, otherwise restart it for updates
- [x] Start the application if it's the first deployment, otherwise restart it for updates
- [ ] Seamless deployments without downtime

## Running the Example
## Deploy an example application

```sh
yarn start
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@
"deployment",
"digitalocean",
"droplet",
"linode",
"node",
"nodejs"
],
Expand Down

0 comments on commit 77185de

Please sign in to comment.