Rynn UI is a simple and easy-to-use API documentation interface built with Express.js. It allows developers to quickly set up and view API documentation with customizable settings using a settings.json file.
- Simple API documentation interface
- Easily customizable with a
settings.jsonfile - Categorized APIs for easy navigation
- Includes real-time settings such as name, version, description, and creator
- Supports image display in the UI for branding
- Links to external resources such as source code and contact info
Check out a live demo of Rynn UI here
- Node.js (>= 14.0.0)
- Clone the repository to your local machine:
git clone https://github.com/RynnKunnn/Rynn-UI.git
- Navigate to the project directory:
cd Rynn-UI - Install dependencies:
npm install
- Modify the
settings.jsonfile to configure your API documentation. - Start the server:
npm start
Your API documentation should now be available at http://localhost:4000.
You can easily customize the UI by editing the settings.json file. Below is a breakdown of the configurable fields:
name: Sets the name of your API (e.g., "Rynn Api's").version: Specifies the version of your API interface (e.g., "Rynn UI").description: A brief description of your API documentation.
status: Indicates the current status of your API (e.g., "Online!").imageSrc: An array of image URLs to display in the header. Multiple images can be set for variety.imageSize: Defines responsive image sizes based on the device type:mobile: Size for mobile devices (e.g., "80%").tablet: Size for tablets (e.g., "40%").desktop: Size for desktops (e.g., "40%").
creator: Displays the creator's name in the interface.
name: Label for the link (e.g., "Source Code").url: The URL to the resource.
Organize APIs into categories for better navigation:
- Category Name (e.g., "AI (Artificial Intelligence)")
items: Define individual APIs within the category.name: The name of the API (e.g., "LuminAI").desc: A short description of the API (e.g., "Talk with luminai").path: The endpoint path for the API (e.g., /ai/luminai?text=).
Here’s an example of how your settings.json file might look:
{
"name": "Rynn Api's",
"version": "Rynn UI",
"description": "Simple and Easy-to-Use API Documentation",
"header": {
"status": "Online!",
"imageSrc": [
"https://media4.giphy.com/media/l0Iy33dWjmywkCnNS/giphy.gif?cid=6c09b952p3mt40j1mgznfi9rwwtccbjl7mtc2kvfugymeinr&ep=v1_internal_gif_by_id&rid=giphy.gif&ct=g"
],
"imageSize": {
"mobile": "80%",
"tablet": "40%",
"desktop": "40%"
}
},
"apiSettings": {
"creator": "Rynn"
},
"links": [
{
"name": "Source Code",
"url": "https://github.com/rynxzyy/Rynn-UI"
},
{
"name": "Contact Me",
"url": "https://wa.me/6285173370004"
}
],
"categories": [
{
"name": "AI (Artificial Intelligence)",
"items": [
{
"name": "LuminAI",
"desc": "Talk with luminai",
"path": "/ai/luminai?text="
},
{
"name": "HydroMind",
"desc": "Talk with hydromind",
"path": "/ai/hydromind?text=&model=",
"innerDesc": "See the list of supported AI models here: https://mind.hydrooo.web.id"
}
]
},
{
"name": "Random",
"items": [
{
"name": "Blue Archive",
"desc": "Blue Archive Random Images",
"path": "/random/ba"
}
]
},
{
"name": "Search Tools",
"items": [
{
"name": "YouTube",
"desc": "Video search",
"path": "/search/youtube?q="
}
]
}
]
}This structure allows you to easily adapt and configure the interface to suit your API needs!
This project is designed to be easily deployable on various platforms. You can host it on any platform that supports Node.js applications. Some popular options include:
- Vercel: Easy deployment with minimal configuration.
- Heroku: A platform-as-a-service for deploying, managing, and scaling apps.
- Netlify: A platform for deploying static sites and serverless functions.
- DigitalOcean: Cloud infrastructure for deploying apps with more control over the environment.
- AWS: Amazon Web Services for scalable and customizable cloud hosting.
- Railway: A platform for deploying apps with easy integration and deployment steps.
Make sure your platform supports Node.js, and configure it to run your API according to the platform’s deployment guidelines.
If you need help with deployment, feel free to reach out to the creator or check the documentation of your chosen platform.
This project is created and maintained by:
- Rynn: Creator and main developer of the project.
- Lenwy: For the inspiration behind the project.
- Siputzx: For providing the LuminAI API.
Special thanks for the support and contributions throughout the development.
This project is licensed under the MIT License.