Add npm start script and development instructions

This commit is contained in:
Abraham Williams
2019-08-22 15:13:12 -05:00
parent d2a1d7df44
commit f551b2c810
3 changed files with 14 additions and 2 deletions

View File

@@ -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)
* [Dribbble](https://dribbble.com)