Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/likecoin/oice-server
oice server and worker. oice is the next generation visual novel editor, featuring friendly and codeless UI, high quality art and assets, and compatibility with kirikiri KAG script.
https://github.com/likecoin/oice-server
cornice kirikiri krkr oice pyramid python sqlalchemy visual-novel
Last synced: 2 days ago
JSON representation
oice server and worker. oice is the next generation visual novel editor, featuring friendly and codeless UI, high quality art and assets, and compatibility with kirikiri KAG script.
- Host: GitHub
- URL: https://github.com/likecoin/oice-server
- Owner: likecoin
- License: other
- Created: 2017-10-03T11:10:44.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-12-02T17:58:47.000Z (11 months ago)
- Last Synced: 2024-05-07T12:02:59.841Z (6 months ago)
- Topics: cornice, kirikiri, krkr, oice, pyramid, python, sqlalchemy, visual-novel
- Language: JavaScript
- Homepage: https://oice.com
- Size: 1.3 MB
- Stars: 13
- Watchers: 9
- Forks: 6
- Open Issues: 44
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.txt
- License: LICENSE
Awesome Lists containing this project
README
Oice-server(modmod) README
==================
[](https://circleci.com/gh/likecoin/oice-server)
- [Basic version](#basic-version)
- [Python Server](#python-server)
- [DB Migration commans](#db-migration-commands)
- [Import / Export worker](#import-export-worker)
- [Seed](#seed)
- [Suggested Dev Setup](#suggested-dev-setup)
- [Building docker image for use in oice/kubernetes](#building-docker-image-for-use-in-oice-kubernetes)
- [Swagger UI with modmod.yaml](#swagger-ui-with-modmod.yaml)
- [Docker Image](#docker-image)
- [Start Swagger UI](#start-swaggerui)
- [Stop Swagger UI](#stop-swaggerui)
Oice-server(modmod) project consist of
Basic version
-------------
- Python3.4+
- Assume Maria10.0 +
- Redis3.0+
- nodejs v0.12+
- pip 1.5.6+ (Other version specific at requirements.pip)
- Assuming `unzip` and `zip` is avalible. (nots ubuntu is not installed by
default)
Python Server
---------------
How to run the python
- `cd `
- `$VENV/bin/python setup.py develop`
- `$VENV/bin/pserve development.ini`
DB Migration commands
---------------------
- Create a migration:
`alembic -c development.ini revision -m "new table"`
- Running migrations:
`alembic [-c development.ini] upgrade head`
- Downgrade migration:
`alembic [-c development.ini] downgrade -1`
Import / Export worker
-----------------------
In Import/Export workflow, you will need to open the pubsub server to get
notified with the long runing process.
- Run the worker
`rqworker`
- Run Redis, refs: http://redis.io/download
`redis-server`
- Run Socket.io
Install the deps `(socket.io) npm install`
`node socket.io/server.js`
Seed
-----
- After running setup.py
- Add default tags to database `initialize_modmod_db`
- Add dummy projects and ks files `modmod_load_dummy`
Suggested Dev Setup
-------------------
- Please refer to [oice repository](https://github.com/lakoo/oice-deployment) README.md
## Building docker image for use in oice/kubernetes
```bash
$ ./build.sh
```
pserve image will be tagged as `modmod`
socket.io image will be tagged as `modmod-socket`
## Swagger UI with modmod.yaml
The set up will copy swagger/yaml/modmod.yaml to docker image. Swagger UI is hosted on localhost:9876.
### Docker Image
To create the docker image of Swagger UI, in swagger/, run:
```bash
./build.sh
```
### Start Swagger UI
To start Swagger UI, in `./swagger/`, run:
```bash
./start.sh
```
### Stop Swagger UI
To stop Swagger UI, in `./swagger/`, run:
```bash
./stop.sh
```