https://github.com/evangipson/tins

TypeScript Interactive Narratives & Stories will set up a world for you to view and interact with on the web.
https://github.com/evangipson/tins

generative-history generative-text interactive-fiction typescript

Last synced: 10 days ago
JSON representation

TypeScript Interactive Narratives & Stories will set up a world for you to view and interact with on the web.

• Host: GitHub
• URL: https://github.com/evangipson/tins
• Owner: evangipson
• License: agpl-3.0
• Created: 2018-07-04T19:24:26.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-07-04T20:31:17.000Z (over 6 years ago)
• Last Synced: 2024-11-22T17:33:52.684Z (2 months ago)
• Topics: generative-history, generative-text, interactive-fiction, typescript
• Language: TypeScript
• Homepage: http://evangipson.com/tins
• Size: 27.3 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# [TypeScript Interactive Narratives & Stories](http://evangipson.com/tins)

TypeScript Interactive Narratives & Stories (tins) will set up a world for you to view and interact with on the web.

tins started as a "randomly generated Wikipedia" style web project.

| tins Readme |

|---|

| [Built With](#built-with) |

| [Compiling](#compiling) |

| [Contributing](#contributing) |

| [License](#license) |

# Built With

* [TypeScript](https://www.typescriptlang.org/)

* [CSS3](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS3)

* [HTML5](https://developer.mozilla.org/en-US/docs/Web/Guide/HTML/HTML5)

* [Visual Studio Code](https://code.visualstudio.com/)

* [Google Chrome](https://www.google.com/chrome/)

* [npm](https://www.npmjs.com/)

# Compiling

To compile the TypeScript in the project:

* Run ```npm install --save-dev typescript```

* When in Visual Studio Code, type **control + shift + B** to bring up your list of tasks.

* Start the ```tsc-watch``` task.

* Save any file, and you will now have a **src/main.js**, which is referenced by the main **index.html** file.

    * Note: This is due to the [tsconfig.json](tsconfig.json) file.

# Contributing

Thank you so much for your interest in contributing to tins!

If you find a bug - then check out any [open issues](https://github.com/evangipson/tins/issues) to see if your bug is already reported. If not, [create a new issue](https://github.com/evangipson/tins/issues/new), please!

# License

tins is licensed under [AGPL 3.0](https://www.gnu.org/licenses/agpl-3.0.en.html). If you are interested, [take a look at tins's license](LICENSE).