NPC Generator is a collaboration between a UX/UI Designer, a Backend Engineer, and, eventually, a Frontend Engineer who were inspired by all the great other NPC Generators out there, but felt they had a few ideas of their own that they wanted to explore. It utilizes the Open5e API and D&D 5e API, for which we are eternally grateful.
Run the following commands to get the generator up and running on your local machine:
git clone https://github.com/LHJE/npc_generator.git
bundle install
bundle update
rails db:{create,migrate,seed}
Seeding may take up to 2 minutes (mainly because there are so many spells!), but you'll only have to do that once. Make some tea or surf the web! You've earned it.
This has created a file called application.yml in your config folder.
At the bottom of that file, paste this:
DND_URL: "https://api.open5e.com"
SECOND_DND_URL: "https://www.dnd5eapi.co/api"
Luckily both of the API's used here are open, so there are no API Keys.
After you've run those commands, simply go run rails s in your terminal, and go to localhost:3000 in your web browser, and you should be good to go!
Below is our schema.
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
Copyright 2020 Luke Hunter James-Erickson, Cecile Elliott
Permission is hereby granted to any person obtaining a copy of this software and associated materials to make use of the software and associated materials according to the terms of the MIT License IF AND ONLY IF they have not read any portion of this file.
Any person who has read any portion of this file may not make any use of the software and associated materials for any purpose whatsoever. Any permissions previously granted to any person to use this software and associated materials terminate and are revoked with immediate effect upon their reading of any portion of this file. ;)