jsmob v0.1.0
JSmob
JSON Schema Manager for Objects and Blogs is exactly that - a JSON schema manager that faciliates creation of JSON objects based off of JSON schemas, as well as the creation of the JSON schemas themselves. JSmob includes an implementation that showcases its features for a blogging system based on JSON flat files. Stay tuned, this will be a very exciting project!
Getting Started
This project is designed to work on any static site host and has relatively frugal requirements to get up and running.
Prerequisites
- Node.js 8+
Install it
Checkout the code and run npm install
in the root directory of the repo.
Run it
Start the web runtime server with a npm start
command, and go to localhost:4200
on your browser of choice.
Built With
- Node.js - Server runtime
- npm - Dependency management
- Angular - Front-end framework
- AngularCLI - Development workspace configuration
- JSON Schema - Making all of this possible
Contributing
Please read the CODE_OF_CONDUCT.md
for details on our code of conduct.
Pull Request Process
- Ensure passing build status and full test coverage of newly added code.
- Increase the version number in
package.json
to the appropriate version that this Pull Request represents. - Every Pull Request will be peer-reviewed without exception and is subject to change requests. Once all appropriate reviewers are designated, have approved the request, and no remaining change requests exist, only then will the pull request will be merged.
- Some branches may be designated as protected branches (such as the
master
branch), and some may require specific administrators to approve the merge.
Versioning
SemVer is used for versioning in this project. All released versions will be merged into the master
branch and tagged.
License
This project is licensed under the GNU Affero General Public License v3.0 - see the LICENSE file for details.
Acknowledgments
- Shoutout to PurpleBooth for helping me create this readme with a very helpful readme template.
6 years ago