Skip to content

AliciaAMT/documentation-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Mandalan Tales

Description

Mandalan Tales is an online role-playing game (RPG) that is accessible and works on any device. It uses simple 2D graphics and a text-based interface. Players can create thier own game worlds after completing the main quest.

Repository Structure

Documentation

  • /docs - Documentation
  • /docs/src - Markdown Prototypes
  • /proto - HTML Prototypes

Application

  • /src - Application Source Code

Assets

  • /assets - Application and Documentation Assets

Installation

Dependencies

  • We strongly recommend a node version manager like nvm
  • To install node.js visit nodejs.org

Setup

  • To install the application, execute the following command from the root directory:
$ npm install

or

$ npm ci

for a clean install.

Configuration

  • To configure the server:

Troubleshooting

  • The biggest issue we've seen is with node versioning. If you're having trouble, try installing nvm and using the version of node specified in the DEPENDENCIES file.

Usage

  • To run the application, execute the following command from the root directory:
$ npm start

Contributing

We welcome contributions to this project. Please read our CONTRIBUTING documents for details.

Legal

Code of Conduct

See our CODE_OF_CONDUCT document for details.

License

This project is licensed under copyright. See LICENSE for

Acknowledgements

See our ACKNOWLEDGEMENTS document for details.

Support

See our SUPPORT document for details.

About

No description, website, or topics provided.

Resources

Code of conduct

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published