Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/evangipson/jstory
jStory will generate you a story using javascript.
https://github.com/evangipson/jstory
firebase gulp html javascript scss story
Last synced: 22 days ago
JSON representation
jStory will generate you a story using javascript.
- Host: GitHub
- URL: https://github.com/evangipson/jstory
- Owner: evangipson
- Created: 2016-11-19T21:47:27.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2017-03-28T19:40:08.000Z (almost 8 years ago)
- Last Synced: 2024-11-22T17:34:15.608Z (3 months ago)
- Topics: firebase, gulp, html, javascript, scss, story
- Language: JavaScript
- Homepage: http://evangipson.com/jstory
- Size: 30.3 KB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# jstory
jStory will generate you a story using javascript.
| jStory Readme |
|---|
| [Getting Started](#getting-started) |
| [Built With](#built-with) |
| [Contributing](#contributing) |
| [Versioning](#versioning) |
| [Authors](#authors) |
| [License](#license) |
## Getting Started
If you want a local copy of jStory, just fork the repository, and set this up in a folder somewhere on your computer. After that, run the gulpfile.js to build the JavaScript and the SCSS, then you can use the index.html to view the web page.
You will have to create a new Firebase database and upload new configuration settings in jStory/src/js/db.js if you'd like to detach from the main database.
## Built With
* JavaScript
* CSS
* HTML
* [Gulp](http://gulpjs.com/)
* [Firebase](https://firebase.google.com/)
* [Visual Studio Code](https://code.visualstudio.com/)
* Google Chrome
## Contributing
Have a look at the [issues with jStory](https://github.com/evangipson/jstory/issues), and create a pull request containing your code so it can be reviewed be merged into the source!
I will run all new javascript through [JSHint](http://jshint.com/) before merging into master.
## Versioning
Chessy is maintained using a 3-digit versioning system, represented by:
```
[Major Version].[Minor Version].[Update]
```
For instance, the first stable build of jStory will be 1.0.0.
## Authors
* **Evan Gipson** - *[Evan's Website](https://evangipson.com/)*
## License
This project is licensed under the MIT License.
```
Copyright (c) 2016 EVAN GIPSON
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```