Skip to content

Commit 4c6da53

Browse files
authored
Create README.md
1 parent 87f4b4f commit 4c6da53

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# UIGF-API
2+
Translation API for UIGF-Org, to provide fundamental i18n data for software using UIGF/SRGF standard.
3+
4+
## How to Deploy
5+
- Install [Docker](https://docs.docker.com/engine/install/)
6+
- Modify image name and version in `build.sh` and run it to build docker image
7+
- You may use `Dockerfile-alpine` instead of `Dockerfile` if you have a more limited disk space
8+
- Create a new database and initial it with `uigf_dict.sql`
9+
- Modify database, network port and App settings in `run.sh`
10+
- Run `run.sh` to start the container
11+
12+
## Live Version
13+
UIGF-API is currently running on [https://api.uigf.org](https://api.uigf.org) and accelerated by [Cloudflare](https://www.cloudflare.com/)
14+
15+
<a href="https://www.cloudflare.com/"><img src="https://uigf.org/CF_logo_stacked_blktype.png" width="180" height="60"></a>

0 commit comments

Comments
 (0)