⚠️ WARNING ⚠️
Development has been moved to auguwu/Arisu for a fresh, clean commit history than this repository. Give it a star!
~ Noel
☔ Arisu
Translation made with simplicity, yet robust. Made with💖 using TypeScript, React using Next.js.
Features
Open Source and Free — Arisu is 100% free and open source, so you can host your own instance if you please!🏘️ Housed in a place — Arisu plans to be a special housing for your translations into one place.🔍 User Friendly UI — Arisu plans to give a UI/UX design that is simple to the end user, yet modern.✨ Multi Projects — House a monorepo with ease without any complex UI/UX designs.⚡ Robust — Arisu makes your workflow way easier and manageable without any high latency.
...and much more!
Projects
This repository is split into a few projects, each with their own purpose. This is managed by a Yarn 1 workspace, we had many difficulties with using Yarn 2.
- frontend — The frontend of Arisu, built with React.
- backend — The backend of Arisu, this is where the API is hosted.
- github-bot — A bot that automatically syncs your translations with GitHub.
There are other projects within the Arisu ecosystem, but they are split into different repositories under the arisuland organization.
If the projects return a 404 status code, it means that the project is not yet ready for public use.
| Name | Description | Status |
|---|---|---|
| A command-line interface to automate the process of handling translations, merging translations, etc. | ||
| Documentation site for Arisu, showcasing the REST API and other stuff | ||
| Translation monorepo for Arisu | ||
| Customizable themes for Arisu, so style however you want to! |
Self-hosting
Before we get started, I recommend learn how to run Node.js projects before you install Arisu. The Arisu Team will not help you if you don't understand how to run a Node.js project. :)
⚠️ Arisu is not ready for production yet! So be cautious before running (un)stable releases.
Prerequisites
Before we can get started, you need to have the following things installed:
- PostgresSQL v11+ ~ Main database thats Arisu utilizes.
- Node.js v14+ ~ Runtime engine to run the project.
- Redis v6.2+ ~ In-memory data store for Arisu.
- Git v2.31+ ~ A version control system to get updates of Arisu easily.
Optional Tools
There are tools you can use to enhance the experience, but the following is not recommended in most cases:
- Docker ~ A containerization tool to run Arisu.
- Sentry ~ A error-reporting tool to track down bugs or errors in Arisu.
- Bell ~ GitHub bot to push translations into Arisu or vice versa with GitHub. View the documentation for more information.
Installation
You wish to use Docker, I recommend reading the Docker section below.
# Clone the repository from GitHub
$ git clone https://github.com/arisuland/Arisu.git && cd ArisuOpen a new browser session and go to
http://localhost:17093/to see Arisu in action.
Installation (Docker)
You can run Arisu with Docker, but you will need to have Docker installed on your machine before getting started.
| Branch | Image |
|---|---|
master |
arisuland/arisu:latest |
staging |
arisuland/arisu:staging |
# 1. Pull the image from Docker
$ docker pull arisuland/arisu:<branch>
# 2. Run the image
$ docker run -d -p 9999:17093 arisuland/arisu:<branch> /
--env 'NODE_ENV=production' /
--volume './config.yml:/opt/Arisu/config.yml' /
--name 'arisu' /
arisuland/arisu:<branch>Open a new browser session and go to
http://localhost:9999/to see Arisu in action.
Configuration
The configuration file is located at ./config.yml. It is a YAML file that contains all the configurations for Arisu.
Be warned that the configuration file is not checked for errors. If you have any issues with the configuration file, please open an issue.
# soon:tm:Contributing
Refer to the Contributing section for more details.
License
Arisu is released under the GPL-3.0 License. <3