EbookFoundation
/
oapen-suggestion-service
mirror of https://github.com/EbookFoundation/oapen-suggestion-service.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

New setup instructions (#35)

pull/56/head
Justin O'Boyle 2023-04-06 14:31:18 -04:00 committed by GitHub
parent a5624cb718
commit 7e4963df77
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 42 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
README.md
View File

@ -2,8 +2,49 @@
The OAPEN Suggestion Engine will suggest ebooks based on other books with similar content.
## Running server
## Running the project
The project uses Docker. To run the project, you will need to have Docker installed. You can find instructions for installing Docker [here](https://docs.docker.com/get-docker/).
### 1. Clone the repository
```bash
git clone https://github.com/EbookFoundation/oapen-suggestion-service.git
```
### 2. Install PostgreSQL
The project uses PostgreSQL as a database. You can find instructions for installing PostgreSQL [here](https://www.postgresql.org/download/).
Make sure it is running, and a database is created.
### 3. Link database to mining engine
Create a `database.ini` file in `oapen-engine/src` with the following:
```
[postgresql]
host=127.0.0.1
database=postgres
user=<username>
password=<your-password>
```
### 4. Link database to API
Edit `config.env` in `api/` with the following:
```
DATABASE_URL="postgres://<username>:<your-password>@127.0.0.1:5432/postgres"
PORT=3001
```
### 5. Run the project
```bash
docker compose up
```
Try connecting to the API at `http://localhost:3001/`.
You can run all the servers together with `./all-dev.sh` -- after installing dependencies with `. ./setup.sh`
## Monorepo components