MartinKondor / dentrit

Write an interactive adventure story with the rest of the world

Home Page:https://dentrit.herokuapp.com

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Dentrit

version Project Status travis code style: prettier Contributions welcome GitHub Issues

Repository of Dentrit.

Dendrit is an online adventure game book where you can choose the story path, or write your own. Be a spy, a princess, a pirate, a rockstar, a ninja…

Getting Started

Prerequisites

  • Node.js v10.9+
  • NPM v6.2+

Deployment

Clone the repository:

$ git clone https://github.com/MartinKondor/dentrit.git
$ cd dentrit

Create a file called config.js, with the content:

Object.defineProperty(exports, '__esModule', { value: true });
const env = process.env.NODE_ENV || 'development';

exports.db = {
    "sessionSecret": '...',
    "url": env === 'development' ? 'dev_database_url' : 'production_database_url',
    "user": 'database_user',
    "password": 'database_password',
};

const sendEmail = (toEmail, title, content) => {
    // TODO
}

Start server with:

$ npm i
$ npm i -g nodemon
$ nodemon

Contributing

Ways to contribute:

  • Check for open issues
  • Read the TODO file

Steps

  1. Fork this repository
  2. Create a new branch (optional)
  3. Clone it
  4. Make your changes
  5. Upload them
  6. Make a pull request here
  7. Profit.

Authors

Become a Patron!

License

Copyright © Martin Kondor 2019

This repository is licensed under the BSD 3-Clause license. See the LICENSE.md file for more details.

About

Write an interactive adventure story with the rest of the world

https://dentrit.herokuapp.com

License:BSD 3-Clause "New" or "Revised" License


Languages

Language:JavaScript 50.5%Language:HTML 44.6%Language:CSS 3.7%Language:Python 1.1%