An open API service indexing awesome lists of open source software.

https://github.com/arnav-kr/box

A place where you can create and solve boxes (challenges, riddles, ctfs, scavenger hunts)
https://github.com/arnav-kr/box

api arnav box ctf express puzzles riddles self-hosted supabase

Last synced: 3 months ago
JSON representation

A place where you can create and solve boxes (challenges, riddles, ctfs, scavenger hunts)

Awesome Lists containing this project

README

        

The Box

## Welcome to **The Box**!
A place where you can create and solve boxes.

boxes can be any type of challenge, puzzle, or riddle. You make a box and the community tries to solve it.



Open the Box

## Usage:
```txt
Base URL: box.arnv.dev

GET / - View Help Message
GET /boxes - get a list of boxes
GET /box/:id - get a box by id

POST /create - create a new box
Content-Type: application/json
data: {
name: string, min 3, max 50
content: string, max 200
solution: string, max 200
difficulty?: number, 1-5
tags?: array of strings, each tag length min 3, max 20
}
POST /box/:id/solve - solve a box by id
Content-Type: application/json
data: {
solution: string, max 200
}
```
## Quick Tips:
- Use [ggl.link/jsonformatter](https://ggl.link/jsonformatter) to easily work with JSON data in Browser
- Use [curl](https://curl.se/) or other tools to interact with the API from terminal

## Author
[Arnav Kumar](https://github.com/arnav-kr)

Happy Box-ing! (lol)🎉