https://github.com/furyforev3r/dicer-api

A dice rolling API done in Typescript using ExpressJS!
https://github.com/furyforev3r/dicer-api

api api-rest dice dice-roller express express-js expressjs typescript vercel vercel-deployment

Last synced: about 3 hours ago
JSON representation

A dice rolling API done in Typescript using ExpressJS!

• Host: GitHub
• URL: https://github.com/furyforev3r/dicer-api
• Owner: Furyforev3r
• Created: 2023-06-26T20:35:23.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-12-07T15:46:45.000Z (12 months ago)
• Last Synced: 2024-04-07T01:16:52.413Z (8 months ago)
• Topics: api, api-rest, dice, dice-roller, express, express-js, expressjs, typescript, vercel, vercel-deployment
• Language: TypeScript
• Homepage: https://dice-roller-api-express-js.vercel.app
• Size: 27.3 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
![Dice Roller API](https://github.com/Furyforev3r/Dice-Roller-API-ExpressJS/assets/88341564/a172c9ac-47fd-46fb-ac93-fde99097416f)

# 🎲 | Dicer-API

**A dice rolling API done in Typescript using ExpressJS!**

**Running on: https://dicer-api.vercel.app/**

## :grey_question: How does it work?

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

## :desktop_computer: 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:** 

```python

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

```

# 📥 Installation

**Clone the repository:**

```bash

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

```

**Install dependencies:**

```bash

npm install

```

# 🖥️ How to Run

**Run the command:**

```bash

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).**