carsonclarke570/lair-ui

UI for Lair, a Dungeons and Dragons 5E campaign manager

Lair UI

The ReactJS front-end of Lair, a Dungeons and Dragons campaign managing front-end.

Development Environment

Prerequisites

• Ensure that the latest npm is installed on your device.
• Have a local instance of the Lair API running.

Running

In order to stand up a locally hosted frontend, you will need to configure some environment variables. Ensure the following are set on your system:

• REACT_APP_API_URL - The URL of where the Lair API instance is hosted. This should most likely be localhost

Then run:

npm start

Navigate to localhost:3000 and you should see the Lair homepage.

Testing

TO-DO: Add tests

Built With

• Lair API - The backend API of Lair
• Material UI - Material Design javascript implementation
• create-react-app - Used to generate project structure

Contributing

Feel free open a pull request and a Code Owner will get around to reviewing it. Don't hesitate to open a new issue or contact an author with any questions you may have.

Versioning

TO-DO: Begin versioning

Authors

• Carson Clarke-Magrab - Initial work - carsonclarke570

License

TO-DO: Add license

Acknowledgments

• The UberEats app