Rikka - A simple image share system

中文版

Rikka is written in Golang primarily, and provide Docker image.

Rikka image has been published to DockerHub, just try it!

Badges above shows latest version and size of Rikka image.

Introduction

Rikka（りっか in Japanese, sound like /ɾʲikka/, not /rikka/）is a integral personal image share system, includes:

• A web application (See Demo section)
• A RESTful API server (See API Doc)
• A CLI tool named Rikkac based on the API (See Rikkac Doc)
• image save plugins (See Plugins Doc)

Other part which not written in Golang (in plan):

• Andrild client
• iOS client

Feature and Advantage

1. Simple and minimalist, no upload history
2. Image address can be copied to various formats
3. Image save part is plug-oriented
4. API provided
5. Modular Web server and API server
6. CLI tool provided
7. Only support latest verstion of Chrome/Firefox/Safari *
8. Cute homepage image
9. An active maintainer

*: Yes, It is advantage! If you can't copy url in view page or stock in "Please wait" message, it is certainly because your browser is too old to support javascript es6 syntax. Front-end is my weakness, I only learn javascript several days. I will be grateful if someone want help me to improve browser compatibility.

Demo

There is a Demo site built with Rikka, password is rikka, just try it.

homepage:

Click Choose button to choose an image.

Input passwordrikka.

Click Upload button.

If no error happened, you will be redirect to preview page:

You will see a "Please wait" message If you uploaded a large file and save process is not finished, just wait a second.

When you see image url, you can click Src, Markdown, HTML, RST, BBCode button to copy image url in that format.

But: Once you close this page, you can't get it back except from browser history(Or you save the url).

This is intentional, Because main design concept is simple, just Upload-Copy-Close-Patse, then you can forget Rikka.

BTW: The preview image of Demo site is saved in Rikka too.

Plugins

Truly image save back-end of Rikka is written in plugin form, can be set by -plugin option.

Please see Rikka Plugins Doc for alivaliable plugins.

API

See Rikka API Doc.

CLI - Rikkac

Rikkac is a CLI tool for Rikka based on Rikka RESTful API.

Build, install, configure and use guide can be found in Rikkac Doc.

Deploy

Want deploy Rikka system of you own? Check Rikka Deploy Doc for deploy guide.

Acknowledgements

• Thanks Golang and her developers
• Thanks Visual Studio Code and her developers
• Thanks open source

License

All code of Rikka system are open source, based on MIT license.

See LICENSE.