Release version v0.4.0

CHANGELOG.md

@@ -0,0 +1,24 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## v0.4.0 02/03/2020
+
+Initial release
+
+### Added
+
+- Created `CHANGELOG.md`
+- Added Node/TypeScript backend for REST API calls
+- Created CI/CD pipeline with `deploy.sh`, `.travis.yml` and `Dockerfile`
+
+### Changed
+
+- Migrated website from Netlify to DigitalOcean
+- Added instructions for new local development to README
+- Removed Netlify badge from README
+- Removed Create React App and replaced with custom Webpack setup
+
+### Removed
+
+- Removed Service Worker due to the application no longer being fully client side

README.md

@@ -6,7 +6,6 @@
  <img src="https://img.shields.io/badge/License-MIT-blue.svg">
   <a href="#contributors"><img src="https://img.shields.io/badge/all_contributors-31-orange.svg?style=flat-square)"></a>
    <a href="https://travis-ci.org/taniarascia/takenote"><img src="https://travis-ci.org/taniarascia/takenote.svg?branch=master"></a>
-  <a href="https://app.netlify.com/sites/tnote/deploys"><img src="https://api.netlify.com/api/v1/badges/a0e055de-cab8-4217-80dd-5bd769b7d478/deploy-status"></a>
 </p>
 
 <p align="center">A web-based note-taking app with GitHub sync and Markdown support. (WIP)</p>
@@ -47,33 +46,56 @@ npm i
 
 ### Development
 
-Node/Express server on port `5000` and hot webpack server on port `3000`.
+In the development environment, an Express server is running on port `5000` to handle all API calls, and a hot Webpack dev server is running on port `3000` for the React front end. To run both of these servers concurrently, run the `dev` command.
 
 ```bash
+# Run client and server concurrently
 npm run dev
 ```
 
+Go to `localhost:3000` to view the app.
+
+API requests will be proxied to port `5000` automatically.
+
 ### Production
 
-Express serves React on port `5000`.
+In production, the React app is built, and Express redirects all incoming requests to the `dist` directory on port `5000`.
 
 ```bash
+# Build client for production and start server
 npm run build && npm run start
 ```
 
+Go to `localhost:5000` to view the app.
+
 ### Run in Docker
 
-Docker container is [also available on the Dockerhub registry](https://hub.docker.com/r/taniarascia/takenote).
+Docker containers are [also available on the Dockerhub registry](https://hub.docker.com/r/taniarascia/takenote).
 
 ```bash
 docker build -t takenote .
 docker run -p 5000:5000 takenote
+# Go to localhost:5000 to view the application
 ```
 
 ### Seed data
 
 To seed the app with some test data, paste the contents of `seed.js` into your browser console.
 
+## Testing
+
+Run unit and component tests.
+
+```bash
+npm run test
+```
+
+Run Cypress e2e tests.
+
+```bash
+npm run cypress:open
+```
+
 ## Contributing
 
 TakeNote is an open source project, and contributions of any kind are welcome! Open issues, bugs, and enhancements are all listed on the [issues](https://github.com/taniarascia/takenote/issues) tab and labeled accordingly. Feel free to open bug tickets and make feature requests. Easy bugs and features will be tagged with the `good first issue` label.
@@ -140,7 +162,7 @@ Thanks goes to these wonderful people:
 
 ## Acknowledgements
 
-- A big thank you to [David Bock](https://dkbock.com/) for logo design
+- A big thank you to [David Bock](https://dkbock.com/) for logo design.
 
 ## Author
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "takenote",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "A web-based note-taking app with GitHub sync and Markdown support.",
   "author": "Tania Rascia",
   "private": false,

src/client/index.tsx

@@ -8,7 +8,6 @@ import { configureStore, getDefaultMiddleware } from '@reduxjs/toolkit'
 import App from '@/containers/App'
 import rootSaga from '@/sagas'
 import rootReducer from '@/slices'
-import * as serviceWorker from '@/serviceWorker'
 import history from '@/helpers/history'
 
 import '@/styles/index.scss'
@@ -29,5 +28,3 @@ render(
   </Provider>,
   document.getElementById('root')
 )
-
-serviceWorker.register()