Skip to content

Furyforev3r/Dicer-API

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Dice Roller API

🎲 | Dicer-API

A dice rolling API done in Typescript using ExpressJS! Running on: https://dicer-api.vercel.app/

❔ How does it work?

The API operates on the "REST API" model, returning a JSON as an HTTP GET response.

🖥️ How to use?

From GET requests with the parameter of the dice rolling operation, you will receive a JSON with the information generated from the parameter. Example:

requests.get("https://dicer-api.vercel.app/10d20+15")

📥 Installation

Clone the repository:

git clone https://github.com/Furyforev3r/Dicer-API.git

Install dependencies:

npm install

🖥️ How to Run

Run the command:

npm start

Acess the application in the browser: http://localhost:PORT or http://localhost:3000

🗃️ What can I put in the main parameter?

Common dice operations (Example: 1d20) and sum modifiers in operations (Example: 1d20+15). It is also possible to roll several separate dice at once (Example: 1d20+10d6+15+15+1d100).