https://github.com/tanem/express-bookshelf-realworld-example-app

:whale: An Express and Bookshelf based backend implementation of the RealWorld API Spec.
https://github.com/tanem/express-bookshelf-realworld-example-app

backend bookshelf express javascript jest knex node realworld

Last synced: 3 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/tanem/express-bookshelf-realworld-example-app
• Owner: tanem
• Created: 2017-10-21T20:49:28.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-04-10T05:05:52.000Z (10 months ago)
• Last Synced: 2024-04-14T14:59:26.969Z (10 months ago)
• Topics: backend, bookshelf, express, javascript, jest, knex, node, realworld
• Language: JavaScript
• Homepage: https://github.com/gothinkster/realworld
• Size: 3.91 MB
• Stars: 98
• Watchers: 3
• Forks: 69
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# express-bookshelf-realworld-example-app

[![build status](https://img.shields.io/github/workflow/status/tanem/express-bookshelf-realworld-example-app/CI?style=flat-square)](https://github.com/tanem/express-bookshelf-realworld-example-app/actions?query=workflow%3ACI)

[![coverage status](https://img.shields.io/codecov/c/github/tanem/express-bookshelf-realworld-example-app.svg?style=flat-square)](https://codecov.io/gh/tanem/express-bookshelf-realworld-example-app)

> An [Express](https://expressjs.com/) and [Bookshelf](http://bookshelfjs.org/) based backend implementation of the [RealWorld API Spec](https://github.com/gothinkster/realworld/tree/master/api).

## Table of Contents

- [Background](#background)

- [Getting Started](#getting-started)

- [Running Tests](#running-tests)

- [Documentation](#documentation)

- [License](#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](https://docs.docker.com/compose/install/) 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](https://github.com/agrison/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](/docs/)

## License

MIT