Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/seriousbug/random-api

A simple, public API to generate random words, numbers, or identifiers
https://github.com/seriousbug/random-api

api random-number random-number-generators

Last synced: about 1 month ago
JSON representation

A simple, public API to generate random words, numbers, or identifiers

Host: GitHub
URL: https://github.com/seriousbug/random-api
Owner: SeriousBug
License: agpl-3.0
Created: 2024-09-28T04:44:20.000Z (3 months ago)
Default Branch: main
Last Pushed: 2024-10-06T04:39:04.000Z (3 months ago)
Last Synced: 2024-11-30T06:48:47.730Z (about 1 month ago)
Topics: api, random-number, random-number-generators
Language: TypeScript
Homepage: https://rnd.bgenc.dev
Size: 167 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE.txt

Awesome Lists containing this project

README

# Random Generation API

[![Codecov](https://img.shields.io/codecov/c/github/seriousbug/random-api)](https://app.codecov.io/gh/SeriousBug/random-api)
[![Website](https://img.shields.io/website?url=https%3A%2F%2Frnd.bgenc.dev&up_message=rnd.bgenc.dev&down_message=rnd.bgenc.dev&label=docs)](https://rnd.bgenc.dev/)
[![GitHub License](https://img.shields.io/github/license/seriousbug/random-api?color=green)](https://github.com/SeriousBug/random-api/blob/main/LICENSE.txt)

A simple, public API to generate random words or numbers. This service is free
to use and available as open-source software. Do you need a random word or a
UUID in a script? Can't pull in dependencies easily? Call this API to grab one
quickly.

## Features

The API provides endpoints for generating:

- Random integers
- Random floating-point numbers
- Dice rolls with various formats
- ULIDs (Universally Unique Lexicographically Sortable Identifier)
- UUIDs (versions 4 and 7)
- Nano IDs
- Random words from various categories like animals or vegetables

## Usage

The API is accessible at `https://rnd.bgenc.dev`. You can make requests to the various endpoints, each with its own set of optional parameters.

Example:

```
https://rnd.bgenc.dev/v1/int?min=1&max=100
```

For detailed information on each endpoint and its parameters, please refer to
the [API documentation](https://rnd.bgenc.dev).

### Rate Limits

There are rate limits in place to prevent abuse. If you need higher rate limits or uptime guarantees, please contact [email protected] to discuss options.

## Local Development

To run the project locally:

1. Clone the repository
2. Install dependencies (Go 1.22 or later and npm are required)
3. Run the following commands:

```bash
npm install
npm run dev
```

This will start both the UI and the backend. The UI will be available at `localhost:5173`. The backend will restart if there are any changes, and the frontend will hot reload.

## License

This project is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0).

### Contributing

Issue reports, and pull requests are always welcome! If you encounter any bugs,
or if there are other generators you'd like to see here, let us know. If you'd
like to contribute, reach out and we can help you get started.

All contributions require a Contributor License Agreement.

## Contact

For inquiries, please contact [email protected]. Increased rate limits, uptime
guarantees, and licensing options are available.

## Disclaimer

While we do our best to keep the service running, there are no guarantees of uptime or support. This service is provided as-is for small projects and scripts.