This project is dedicated to finding a better way for everyday frontend development workflow
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
What things you need to install the software and how to install them
Give examples
A step by step series of examples that tell you have to get a development env running
- run
npm install
within your command shell - run
npm start
to start the application
Give the example
And repeat
until finished
End with an example of getting some data out of the system or using it for a little demo
Add additional notes about how to deploy this on a live system
Node packages including nsp (node security project) to verify if existing dependencies are not vulnerable
- Local Tunnel https://localtunnel.github.io/www/
Here is an example of how you would use local tunnel to share your work-in-progress:
- run
npm install localtunnel -g
in your command line - start the local server, in our case by executing
node build-scripts/src-server.js
- add a new terminal video and run
lt --port 3000
(port number is based on the configuration) - use the url that will be shown in the console
-
NG Rock https://ngrok.com/
-
Surge https://surge.sh/
- NPM build scripts
- Dropwizard - The web framework used
- Maven - Dependency Management
- ROME - Used to generate RSS Feeds
We use SemVer for versioning.
- Billie Thompson - Initial work - PurpleBooth
See also the list of contributors who participated in this project.
This project is licensed under the MIT License - see the LICENSE.md file for details
- Hat tip to anyone who's code was used
- Inspiration
- etc