improve documentation (#43)

* fix permissions

* add links to sub-READMEs
better-pass-related
Eric Hellman 2023-03-27 12:53:06 -04:00 committed by GitHub
parent 376545450d
commit 966c336b68
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 7 additions and 1 deletions

View File

@ -4,7 +4,7 @@ The OAPEN Suggestion Engine will suggest ebooks based on other books with simila
## Running server
You can run all the servers together with `./all-dev.sh` -- after installing dependencies with `./setup.sh`
You can run all the servers together with `./all-dev.sh` -- after installing dependencies with `. ./setup.sh`
## Monorepo components
@ -17,6 +17,8 @@ Our suggestion service is centered around the trigram semantic inferencing algor
You can find the code for the mining engine in `oapen-engine/`.
Information about running the mining engine is in [`oapen-engine/README.md`](oapen-engine/README.md).
**Base dependencies**:
* Python v3.10
* PIP package manager
@ -44,6 +46,8 @@ This API server returns a list of recommended books from the database.
You can find the code for the API engine in `api/`.
Configuration info for the API engine is in [`api/README.md`](api/README.md).
**Base dependencies**:
* NodeJS 14.x+
* NPM package manager
@ -64,6 +68,8 @@ This is a web-app demo that can be used to query the API engine and see suggeste
You can find the code for the web demo in `web/`.
Configuration info for the web demo is in [`web/README.md`](web/README.md).
**Base dependencies**:
* NodeJS 14.x+
* NPM package manager

0
all-dev.sh Normal file → Executable file
View File

0
run-api.sh Normal file → Executable file
View File

0
run-web.sh Normal file → Executable file
View File