Skip to content
🐳 An Express and Bookshelf based backend implementation of the RealWorld API Spec.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
config Replace env configs with docker env vars May 21, 2018
db Add default bio and image values Mar 15, 2018
docs
lib Fix feed endpoint Mar 20, 2018
test-support
.dockerignore
.eslintrc
.gitignore
.travis.yml
Dockerfile
README.md
docker-compose.development.yml
docker-compose.test.yml
docker-compose.yml
package.json
yarn.lock

README.md

express-bookshelf-realworld-example-app

build status coverage status

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

Table of Contents

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 yarn docker:start to start the app.

Running Tests

Run the full test suite with:

$ yarn docker:test

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

$ yarn docker:test --watch

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

$ yarn 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

License

MIT

You can’t perform that action at this time.