Skip to content

Latest commit

 

History

History
127 lines (82 loc) · 1.87 KB

README.md

File metadata and controls

127 lines (82 loc) · 1.87 KB
Raw

GutenKu Api

Ci Apollo

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

  • Node.js (v18)
  • Python (for scraping eBooks)

Installation

  1. Clone the repository:
git clone https://github.com/heristop/gutenku.git
  1. Copy env variables (optional):
cp gutenku/packages/server/.env.dist gutenku/packages/server/.env
  1. Install NPM dependencies:
pnpm i
  1. Install Python dependencies:
python3 -m pip install --upgrade pip
pip3 install -r packages/server/requirements.txt
  1. Install MongoDB:

Using Docker:

With Docker Desktop / Docker Compose V2 command:

docker compose up -d

Or with Docker Compose V1:

docker-compose up -d
  1. Start server and front
pnpm dev

Usage

Fetch

Fetch and store books:

pnpm run setup [--delete]

Run

pnpm run dev

Train

Uses Markov Chain to evaluate transitions:

pnpm train

Generate

Generate Haiku:

pnpm extract

Post

Send Instagram Post:

pnpm post [--selection-count=50] [--no-interaction] [--no-openai]

Test

To run the test suite, execute the following command:

pnpm test

Built With

  • Node.js / TypeScript / ESM
  • Apollo Server
  • GraphQL
  • Tsyringe (DI)
  • Python (for eBook scraping)
  • Natural Language Processing (NLP)

GutenKu Logo

© 2023 heristop / @gutenku.poem. All rights reserved.