Characters

This is an application for management of RPG characters. Prod env is here

Structure and Technologies

The application is built in ReactJS, and uses MongoDB Realm as backend.

The application itself has a classic ReactJS structure, using a src/components folder for most of its code and src/css folder for most of its SCSS.

Inside the src/components folder there are three subfolders, unlike usually done in react. Two of them are the classic pages and presentation, containing page-specific and generic components respectively. The last folder, contexts includes wrapping context components and that are used for data manipulation in the application. hooks includes generic hooks to use in the application, that do not have anything to do with specific application data.

Another folder in the src folder inlucdes the adapters for each of the games with which the application can work. The application uses rpg-js parser for the rpg-yaml language, and the rpg-yaml database of games. Each game's rulebook in the database has an adapter in the games folder (currently only Dungeon World is supported). The adapter is build out of two files, a SCSS file and a JS file. The SCSS file includes how to display the different fields of the character in each of the pages, and the JS file includes the characters settings and event handlers for interactivity.

Contribution

The software is ran using yarn. Just clone the repository, then run yarn install and then yarn start. The application is currently meant only for mobile, so please use an emulator when developing such as the one chrome has.

Known Installation Issues

• If you have a node_modules folder somewhere in your folder tree related to this project's folder with a babel-jest module in it, it may creae problems with yarn install.