Giter Site home page Giter Site logo

Roll For Init

A character creator and interactive character sheet web application for the 5e ruleset of the most popular TTRPG in the world. See it live at rollforinit.herokuapp.com! Due to the nature of the hosting, you may need to refresh a few minutes after the initial load to get the full site.

Demo

Want to see what it's all about? Please see the demo here!

Demo

To Run

To run this application, create a file secret.env in the root directory following the guide below. Ensure MONGODB_URI_RULESET is populated with the ruleset from the 5e-database. Then, in the root directory, simply run:

npm install
npm run start

Required Environment Variables

  • JWT_SECRET
    • A secret code such as a uuid.
  • REDIS_URL
    • Redis URI and protocol (similar to MONGODB_URI) for 5e-srd-api.
    • No need to run local redis-server.
  • MONGODB_URI
    • Production database for user data
  • MONGODB_URI_DEV
    • Development database for user data
  • MONGODB_URI_RULESET
    • Database for ruleset data (read-only)

Additional Environment Variables

  • PORT
    • Main port for the web application, defaults to 8080
  • PORT_API
    • Separate port for the API, defaults to 3005
  • NODE_ENV
    • Set to 'production' if you are building for deployment
    • Set to 'development' if you are developing
  • LEGACY_WATCH=1
    • Try adding this flag if you cannot get nodemon to update on changes
  • SILENCE_WEBPACK=1
    • Add this flag if you want to silence webpack output

GitHub Ettiquette

  • Commit new features to SEPARATE BRANCHES. Never commit to master.
  • Pull often and frequently.
  • Ensure that your commits are frequent and descriptive.

Built With

roll-for-init's Projects

5e-srd-api icon 5e-srd-api

Altered REST API to access altered D&D 5th Edition SRD database

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.