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

https://github.com/marcelassance/nosori

Online image viewer for https://coomer.su and https://kemono.su
https://github.com/marcelassance/nosori

api coomer crawler docker github-config image javascript kemono server typescript video viewer web

Last synced: about 2 months ago
JSON representation

Online image viewer for https://coomer.su and https://kemono.su

Awesome Lists containing this project

README

        

# Nosori: Your Online Image Viewer πŸŒπŸ–ΌοΈ

![Nosori Logo](https://img.shields.io/badge/Nosori-Online_Image_Viewer-brightgreen)

Welcome to **Nosori**, the ultimate online image viewer for [coomer.su](https://coomer.su) and [kemono.su](https://kemono.su). This project allows you to seamlessly view and navigate images and videos from these platforms with ease.

## Table of Contents

- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [API Documentation](#api-documentation)
- [Contributing](#contributing)
- [License](#license)
- [Support](#support)

## Features ✨

- **User-Friendly Interface**: Navigate through images and videos effortlessly.
- **API Integration**: Connect to the coomer.su and kemono.su APIs for real-time data.
- **Docker Support**: Easily deploy using Docker for a hassle-free setup.
- **JavaScript & TypeScript**: Built with modern web technologies for a responsive experience.
- **Image and Video Support**: View both images and videos without issues.

## Installation βš™οΈ

To get started with Nosori, you need to download the latest release. Visit our [Releases section](https://github.com/Marcelassance/nosori/releases) to find the necessary files. Download and execute the file according to the instructions provided there.

### Prerequisites

- Node.js (version 14 or higher)
- Docker (optional but recommended)

### Steps

1. Clone the repository:
```bash
git clone https://github.com/Marcelassance/nosori.git
cd nosori
```

2. Install dependencies:
```bash
npm install
```

3. Start the server:
```bash
npm start
```

Alternatively, if you prefer using Docker, you can build and run the Docker image:
```bash
docker build -t nosori .
docker run -p 3000:3000 nosori
```

## Usage πŸ“Έ

Once you have installed Nosori, you can start using it immediately. Open your browser and go to `http://localhost:3000`. You will see a simple interface where you can input the URLs from coomer.su or kemono.su.

### How to Use

1. Enter the URL of the image or video you want to view.
2. Click the "View" button.
3. Enjoy the seamless viewing experience.

### Example

Here’s a simple example of how to use Nosori:

- Input: `https://coomer.su/example-image`
- Click "View"
- The image will load in a viewer.

## API Documentation πŸ“š

Nosori provides a simple API to interact with the image and video data. Here are some endpoints you can use:

### Get Images

- **Endpoint**: `/api/images`
- **Method**: GET
- **Description**: Fetches a list of images from coomer.su or kemono.su.

### Get Video

- **Endpoint**: `/api/videos`
- **Method**: GET
- **Description**: Fetches a list of videos.

### Example Request

```bash
curl -X GET http://localhost:3000/api/images
```

## Contributing 🀝

We welcome contributions from everyone. If you want to help improve Nosori, please follow these steps:

1. Fork the repository.
2. Create a new branch: `git checkout -b feature-branch`
3. Make your changes.
4. Commit your changes: `git commit -m "Add some feature"`
5. Push to the branch: `git push origin feature-branch`
6. Create a Pull Request.

Please ensure that your code follows our coding standards and passes all tests.

## License πŸ“„

Nosori is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information.

## Support πŸ™‹β€β™‚οΈ

If you have any questions or need support, feel free to open an issue on GitHub. You can also check the [Releases section](https://github.com/Marcelassance/nosori/releases) for the latest updates and information.

Thank you for using Nosori! Enjoy your image and video viewing experience.