conduit

RealWorld Example App

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

This repo is functionality complete — PRs and issues welcome!

Live demo on Glitch: https://realworld-moleculer.glitch.me

Glitch project: https://glitch.com/edit/#!/realworld-moleculer

React + Redux front-end UI is included. For more information on how to this works with other frontends/backends, head over to the RealWorld repo.

Getting started

To get the Node server running locally:

• Clone this repo
• npm install to install all required dependencies
• npm run dev to start the local server
• the API is available at http://localhost:3000/api

Alternately, to quickly try out this repo in the cloud, you can

MongoDB persistent store

Basically the services stores data in an NeDB persistent file storage in the ./data folder. If you have to use MongoDB, set the MONGO_URI environment variable.

MONGO_URI=mongodb://localhost/conduit

Multiple instances

You can run multiple instances of services. Moleculer uses TCP transporter to communicate all instances. No need any additional configuration, it uses UDP for discovery.

To get the Node server running locally with Docker

1. Checkout the repo git clone https://github.com/moleculerjs/moleculer-examples.git

2. cd moleculer-examples/conduit

3. Start with docker-compose: docker-compose up -d --build

   It starts all services in separated containers, a Redis server for caching, a MongoDB server for database and a Traefik reverse proxy. All nodes communicate via Moleculer TCP transporter.

4. Open the http://docker-ip:3000 in your browser

5. Optional: Scale up services

   docker-compose up -d --scale api=3 --scale articles=2 --scale users=2 --scale comments=2 --scale follows=2 --scale favorites=2

Code Overview

Dependencies

• moleculer - Microservices framework for NodeJS
• moleculer-web - Official API Gateway service for Moleculer
• moleculer-db - Database store service for Moleculer
• moleculer-db-adapter-mongo - Database store service for MongoDB (optional)
• jsonwebtoken - To generate JWTs used by authentication
• bcrypt - Hashing user password
• lodash - Utility library
• slug - To encode titles into a URL-friendly format
• ioredis - Redis server for caching (optional)

Application Structure

• moleculer.config.js - Moleculer ServiceBroker configuration file.
• services/ - This folder contains the services.
• public/ - This folder contains the front-end static files.
• data/ - This folder contains the NeDB database files.

Test

Tested with realworld-server-tester.

Local tests is missing currently.

$ npm test

In development with watching

$ npm run ci

License

This project is available under the MIT license.

Contact

Copyright (c) 2016-2020 MoleculerJS