express-bookshelf-realworld-example-app

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

Table of Contents

• Background
• 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!

Getting Started

Ensure Docker Compose is installed, then:

1. Clone this repo.
2. Change to the above dir.
3. 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

This project also passes the realworld-server-tester test suite. First start the server:

$ npm run docker:start

Then in a new terminal window, assuming you've cloned the realworld-server-tester repo and changed to the correct directory, run:

$ java -jar target/realworld-server-tester-0.1.0-SNAPSHOT-standalone.jar http://localhost:3000/api

Documentation

• Docs

License

MIT