This is a simple web application that generates randomized NPC (Non-Player Character) names, images and descriptions for Dungeons and Dragons (DnD) games.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
To run this project, you will need to have Node.js and npm installed on your machine.
-
Clone the repository to your local machine using Git:
git clone https://github.com/llamojha/dnd-npc-generator.git -
Install the dependencies using npm:
cd dnd-npc-generator
npm install
- Create a
.envfile in the root of your project directory and add the following environment variable:
REACT_APP_OPENAI_API_KEY=your_openai_api_key_here
- Run the project using the
startscript:
npm start
The project should now be running on http://localhost:3000/.
- React - A JavaScript library for building user interfaces
- Create React App - A tool for creating React apps with no build configuration
- OpenAI API - An artificial intelligence platform that provides APIs for natural language processing tasks
This project is licensed under the MIT License - see the LICENSE file for details.
- The NPC names and descriptions are generated using the OpenAI API.
- This project was inspired by NPC Generator, a web application for generating randomized NPCs.