/character-sheet

A React/Redux front end application to create and update character sheets for tabletop role-playing games.

Primary LanguageTypeScriptMIT LicenseMIT

Character Sheet

screenshot

A simple React front end application using Redux Toolkit for state management. Users can create character sheets for their tabletop RPGs and update them as their games progress.

Demo App

You can see a demo version of this application deployed to Cyclic here: https://react-character-sheet.cyclic.app

Application Info

This project is written in TypeScript and configured with Node Package Manager. It was bootstrapped with Create React App, using the Redux and Redux Toolkit TypeScript template.

It uses Bootstrap via the React-Bootrap package for front end styling and structure. It uses Jest for front end testing. It also uses Node Express to serve the build in production.

Character sheets will be saved to local storage in the user's browser and will be loaded once returning to the application. Clearing the browser's cache will delete all saved data.

Commands

npm run dev - Run the app in the development mode. Open http://localhost:3000 to view it in the browser.

npm run build - Build the app for production to the build folder (using Webpack). It correctly bundles React in production mode and optimizes the build for the best performance.

npm start - Run the Express server via Node and serve the production build.

npm test - Launches the test runner in the interactive watch mode.

npm run eject - Remove the single build dependency from the project. Once executed, there is no going back.

Install Instructions

Node Package Manager (NPM) is used for dependencies. To install the application locally, follow these instructions:

  1. Install Node.js. NPM comes packaged with it.
  2. Run npm install in the command line while in the project directory. It will install dependencies from the package.json file.
  3. To build for development and run the local dev server at http://localhost:3000, run npm run dev.

License

This project is open source under the terms of the MIT License.