Readify

A book reading, review, and recommendation website with a chat-with-a-book module.

Technologies

• Node.js
• TypeScript
• Express
• PostgreSQL
• Prisma
• JWT Authentication
• Swagger
• Docker
• GitHub Actions
• Jest

Architecture

System Architecture

Running the app

1. Clone the repository:

git clone https://github.com/Eight-Horsepeople-of-the-Graduation/core.git
cd core

2. Install required packages:

pnpm install # can also use npm or yarn instead of pnpm

3. Build and start the Postgres Docker container:

Make sure to have Docker Compose installed.

docker-compose up -d

This command will start the Postgres container in detached mode.

4. Generate Prisma artifacts:

pnpm dlx prisma generate # can also use npx instead of 'pnpm dlx'

This command will generate Prisma artifacts required for the repositories to work properly.

5. Copy the environment variables file:

cp .env.example .env

Then replace the current values with desired values.

6. Run the application:

# development
$ pnpm run start

# watch mode
$ pnpm run start:dev

Testing the app

# unit tests
$ pnpm run test

Usage

Roadmap

• []

Acknowledgments