A book reading, review, and recommendation website with a chat-with-a-book module.
- Node.js
- TypeScript
- Express
- PostgreSQL
- Prisma
- JWT Authentication
- Swagger
- Docker
- GitHub Actions
- Jest
- Clone the repository:
git clone https://github.com/Eight-Horsepeople-of-the-Graduation/core.git
cd core
- Install required packages:
pnpm install # can also use npm or yarn instead of pnpm
- 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.
- 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.
- Copy the environment variables file:
cp .env.example .env
Then replace the current values with desired values.
- Run the application:
# development
$ pnpm run start
# watch mode
$ pnpm run start:dev
# unit tests
$ pnpm run test
- []