Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/akashrchandran/rayso-api
Provides ray.so as a REST API version. Make beautiful and prettified code screenshots by just sending a POST or GET request.
https://github.com/akashrchandran/rayso-api
code code-screenshot nodejs rayso screenshot
Last synced: 4 days ago
JSON representation
Provides ray.so as a REST API version. Make beautiful and prettified code screenshots by just sending a POST or GET request.
- Host: GitHub
- URL: https://github.com/akashrchandran/rayso-api
- Owner: akashrchandran
- License: gpl-3.0
- Created: 2022-07-04T18:39:39.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-09T17:26:48.000Z (4 months ago)
- Last Synced: 2024-07-09T21:51:20.544Z (4 months ago)
- Topics: code, code-screenshot, nodejs, rayso, screenshot
- Language: JavaScript
- Homepage:
- Size: 88.9 KB
- Stars: 19
- Watchers: 1
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Rayso-API
[](https://forthebadge.com)
Provides [ray.so](https://ray.so/) as a REST API version. Make beautiful and prettified code screenshots by just sending a POST or GET request.
`https://rayso-c3754cd07bd3.herokuapp.com/api`
## Parameters
| Parameter | Default value | Type | Description |
| ------------ | --------------- | ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| `code ` | None (required) | String | The code which is used to make the screenshot. |
| `title ` | `"Untitled-1"` | String | The title will be displayed on top of the code box. |
| `theme` | `"breeze"` | String | There are several options of how your box will look like. Available themes: vercel, supabase, tailwind, bitmap, noir, ice, sand, forest, mono, breeze, candy, crimson, falcon, meadow, midnight, raindrop, sunset |
| `background` | `true` | Boolean | If disabled, it will create an image of code box only, without background. |
| `darkMode` | `true` | Boolean | If disabled, it will change your theme to its light version. |
| `padding` | `32` | String or Number | Distance between borders and code box. Available values: 16, 32, 64 and 128. |
| `language` | `"auto"` | String | You better leave it auto :/ However, you can try to pass some language name and if it worked, good for you! |
### Using GET Request `/`
> It uses query parameters.
```
http://localhost:3000/api?code=console.log(%22Hello%20World%22)%3B&language=javascript&title=Test
```
### Using POST Request `/`
**Body** is JSON with these params:
```json
{
"code": "console.log('Hello World');",
"language": "javascript",
"title": "Test"
}
```
### Example output
# Deployment
# Deployment
To deploy the Rayso-API on Heroku, you can use the Heroku Button. Just click the button below and follow the instructions:
[](https://dashboard.heroku.com/new?template=https://github.com/akashrchandran/rayso-api)
Once the deployment is complete, you will have your own instance of the Rayso-API running on Heroku.
# Local Development
To run the Rayso-API locally, you can follow these steps:
1. Clone the repository:
```bash
git clone https://github.com/akashrchandran/rayso-api
cd rayso-api
```
2. Install the dependencies:
```bash
npm install
```
3. Start the development server:
```bash
npm start
```
### Credits
• [s0ftik3](https://github.com/s0ftik3)
-> For creating rayso-api package but now it is not maintained so I have forked his and upated [rayso](https://npmjs.com/rayso).
• [Me](https://akashrchandran.in)
-> For nothing.