From f551b2c8105bf4fc2766d8da7e5f4ed94290c863 Mon Sep 17 00:00:00 2001 From: Abraham Williams <4braham@gmail.com> Date: Thu, 22 Aug 2019 15:13:12 -0500 Subject: [PATCH] Add npm start script and development instructions --- .gitignore | 1 + README.md | 13 +++++++++++-- package.json | 2 ++ 3 files changed, 14 insertions(+), 2 deletions(-) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 000000000..3c3629e64 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +node_modules diff --git a/README.md b/README.md index 3cf7289d4..d649ac3d3 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@ When I wrote this, only God and I understood what I was doing. Now, only God kno :heart: **Lightweight and minimal**: Crafted with minimalistic UI design -:electric_plug: **Real-time demo**: Send requests and get response right away! +:electric_plug: **Real-time demo**: Send requests and get response right away! :robot: **VIBGYOR**: Neon combination of colors for background and foreground @@ -61,6 +61,15 @@ You're done! --- +## Developing + +1. [Clone this repo](https://help.github.com/en/articles/cloning-a-repository) with git. +1. Install dependencies by running `npm install` within the `postwoman` directory. +1. Start the development server with `npm start`. +1. Open development site by going to [http://localhost:8080](http://localhost:8080) in your browser. + +--- + ## Contributing Please read [CONTRIBUTING](CONTRIBUTING.md) for details on our [CODE OF CONDUCT](CODE_OF_CONDUCT.md), and the process for submitting pull requests to us. @@ -113,4 +122,4 @@ This project is licensed under the [MIT License](https://opensource.org/licenses * Hat tip to anyone who's code was used * Inspirations: - * [Dribbble](https://dribbble.com) \ No newline at end of file + * [Dribbble](https://dribbble.com) diff --git a/package.json b/package.json index d91946d2e..1e02598d0 100644 --- a/package.json +++ b/package.json @@ -8,9 +8,11 @@ "author": "liyasthomas", "version": "0.1.0", "devDependencies": { + "http-server": "^0.11.1", "jshint": "^2.10.2" }, "scripts": { + "start": "http-server", "test": "jshint travis.js" } }