Monstershuffler REST API

New backend interface for monstershuffler.com

The purpose of this new interface is to allow other websites and platforms to access monsters and npcs created in Monstershuffler.com

( this project is still very incomplete, but you can check its progress if you want to )

Dependencies & tools used

• Fastify: a node.js framework inspired by Express.js
• TypeScript: a strongly typed programming language that builds on JavaScript
• Prisma: a next-gen ORM that makes this project (semi) independent from the type of db chosen
• Zod: a TypeScript-obsessed "schema" validator
• JWT: easy authorizations with JSON and tokens
• Swagger: automatic API specifications (yay!)

Initial project setup based on TomDoesTech's YouTube tutorial:

• YouTube: https://www.youtube.com/watch?v=LMoMHP44-xM
• github: https://github.com/TomDoesTech/fastify-prisma-rest-api

How to run this project locally

To run this project locally, you need to install the following requirements in your pc:

• nodejs v16+
• mysql v8+ (*will probably move to PostreSQL soon)

The steps to install node and mysql will depend on your operative system. Find a guide online or ask ChatGPT.

Create an empty mysql database, then use the terminal to import the two .sql files inside the folder /db of this project:

# first upload the structure of the database
mysql -u your_mysql_username -p db_name < db_structure.sql
# then upload the seeds (starting values, like the admin user, spells, etc...)
mysql -u your_mysql_username -p db_name < db_seeds.sql

Create a file called .env in the root folder of this project, then add the following lines of code inside:

# NODE SETTINGS
MAX_LISTENERS=100

# PRISMA SETTINGS
# DATABASE_URL="mysql://root:password@localhost:3306/monstershuffler"
DATABASE_URL="postgres://postgres:password@localhost:5432/monstershuffler?schema=monstershuffler"

# JWT SETTINGS
JWT_SECRET="add_some_16+_random_characters_here"

# EMAIL SETTINGS
SMTP_HOST="smtp.gmail.com"
SMTP_PORT=25
AUTH_USER="user"
AUTH_PASSWORD="super secret password"

#OPENAI
OPENAI_API_KEY="sk-s3Cr3tK3y"

You can now run the project using npm or yarn:

# npm
npm run dev
# yarn
yarn dev

Admin user in db_seeds.sql

user: [email protected]
password: iambatman