temple/Suwayomi-Server
1
0
Fork 0
mirror of https://github.com/Suwayomi/Suwayomi-Server.git synced 2026-06-30 17:34:39 -05:00
Code Issues Packages Projects Releases Wiki Activity

add readme and license, rename the server module

Browse Source
This commit is contained in:
Aria Moradi
2020-12-24 15:31:21 +03:30
parent 4f595d1166
commit e9c8722cbf
47 changed files with 397 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
README.md Normal file
View File

@@ -0,0 +1,23 @@
# Tachidesk
A not so much port of [Tachiyomi](https://tachiyomi.org/) to the web (and later Electron for the desktop experience)!
This project has two components:
1. server: contains some of the original Tachiyomi code and serves a REST API
2. webUI: A react project that works with the server to do the presentation
## How do I run the thing?
### The Server
run `./gradlew :server:run` to run the server
### the webUI
how to do it is described in `webUI/react/README.md` but for short,
first run `yarn` to install the node modules(do this only once)
then `yarn start` to start the client if a browser windows doesn't open automatically,
then open `http://127.0.0.1:3000` in a modern browser.
## License
Copyright (C) 2020 Aria Moradi
This Source Code Form is subject to the terms of the Mozilla Public
License, v. 2.0. If a copy of the MPL was not distributed with this
file, You can obtain one at http://mozilla.org/MPL/2.0/.