https://github.com/stevengregory/sn-story-forge
A Ruby tool for generating Markdown files from ServiceNow user stories
https://github.com/stevengregory/sn-story-forge
ruby servicenow
Last synced: 6 months ago
JSON representation
A Ruby tool for generating Markdown files from ServiceNow user stories
- Host: GitHub
- URL: https://github.com/stevengregory/sn-story-forge
- Owner: stevengregory
- Created: 2020-08-04T03:50:39.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2025-04-02T15:49:16.000Z (over 1 year ago)
- Last Synced: 2025-04-02T16:46:41.901Z (over 1 year ago)
- Topics: ruby, servicenow
- Language: Ruby
- Homepage:
- Size: 51.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# SN Story Forge
An experimental Ruby tool that generates local Markdown files from ServiceNow user stories; capturing acceptance criteria, story points, and other details for offline reference. It organizes them by assignment, product, and archives each story for backup.
## Prerequisites
- [Ruby](https://www.ruby-lang.org/en/)
- [Bundler](https://bundler.io/)
## Installation
```bash
bundle install
```
## Configuration
```bash
cp .env.example .env
```
## Running
```bash
ruby src/run.rb
```
## Project Structure
```
.
├── dist/ # Generated output directory
│ ├── Archive/ # Archived stories in YAML format
│ ├── My Stories/ # All stories assigned to you (across all products)
│ └── Product/ # Stories organized by product
│ └── {product}/ # Product-specific folders with state subfolders
├── src/
│ ├── config.rb # Configuration settings
│ ├── request.rb # ServiceNow API request handling
│ ├── run.rb # Main execution script
│ ├── story.rb # Story management logic
│ ├── template.rb # Markdown template generation
│ └── utils.rb # Utility functions
├── Gemfile # Ruby dependencies
├── .env # Environment configuration (create from .env.example)
└── .env.example # Example environment configuration
```