express-bookshelf-realworld-example-app

An Express and Bookshelf based backend implementation of the RealWorld API Spec.

Note: Bookshelf.js is in maintenance mode (last release ~2020). This repo remains a Bookshelf reference implementation for the RealWorld community. For new projects, consider Objection.js (same Knex foundation, actively maintained), raw Knex, or Prisma.

Table of Contents

• Background
• Prerequisites
• Getting Started
• Running Tests
• Documentation
• License

Background

This project was created in order to familiarise myself with some key technologies in use at my day job. It's not intended to be production ready, but PRs that address this and any other issues are welcome!

Prerequisites

• Node.js >= 22
• Docker and Docker Compose

Getting Started

Ensure Docker Compose is installed, then:

1. Clone this repo.
2. Change to the above dir.
3. Copy .env.example to .env and adjust values as needed.
4. Run npm run docker:start to start the app.

Running Tests

Run the full test suite with:

$ npm run docker:test

CLI args will be passed through to Jest. For example, to run in watch mode:

$ npm run docker:test -- --watch

Documentation

• Docs

License

MIT