Skip to content
master
Switch branches/tags
Code
This branch is up to date with master.
Contribute

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

RealWorld Example App

RealWorld Backend Build Status

Feathers codebase containing real world examples (CRUD, auth, advanced patterns, etc) that adheres to the RealWorld spec and API.

Demo    RealWorld

This codebase was created to demonstrate a fully fledged fullstack application built with Feathers (and Mongoose) including CRUD operations, authentication, routing, pagination, and more.

We've gone to great lengths to adhere to the Feathers community styleguides & best practices.

For more information on how to this works with other frontends/backends, head over to the RealWorld repo.

How it works

Feathers is a service oriented REST and Real Time API layer. Endpoints are defined as services.

Application Structure

  • app.js - Entry point for the application.
  • config/ - Configuration/environment variables for the server.
  • src/services/ - Service implementations
  • src/middleware/ - Middleware implementations
  • src/models/ - Schema definitions for our Mongoose models(Easily changed to use other databases).
  • src/hooks/ - Hooks for running code before and after services. Used for formatting requests and responses correctly.
  • src/common/ - Common helper functions.

Getting started

To get the Feathers server running locally:

  • Clone this repo
  • cd feathers-realworld-example-app
  • npm install to install all required dependencies
  • Set environment variable MONGODB_FEATHERS_REALWORLD to the connection string for your mongodb instance (You can install a community edition instructions or create an instance on mLab: instructions).
  • npm start to start the local server (or npm test to run tests).

About

Feathers implementation for RealWorld example app

Resources

License

Releases

No releases published

Packages

No packages published