Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gothinkster/moleculer-node-realworld-example-app
Exemplary real world application built with Moleculer
https://github.com/gothinkster/moleculer-node-realworld-example-app
microservices moleculer realworld
Last synced: about 2 months ago
JSON representation
Exemplary real world application built with Moleculer
- Host: GitHub
- URL: https://github.com/gothinkster/moleculer-node-realworld-example-app
- Owner: gothinkster
- License: mit
- Archived: true
- Created: 2017-11-15T19:20:38.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-06-11T07:28:50.000Z (over 6 years ago)
- Last Synced: 2024-08-09T13:16:18.525Z (6 months ago)
- Topics: microservices, moleculer, realworld
- Language: JavaScript
- Homepage: https://realworld.io
- Size: 854 KB
- Stars: 103
- Watchers: 11
- Forks: 27
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 
> ### [Moleculer](http://moleculer.services/) codebase containing real world examples (CRUD, auth, advanced patterns, etc) that adheres to the [RealWorld](https://github.com/gothinkster/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](https://github.com/icebob/react-redux-realworld-example-app) front-end UI is included.*
*For more information on how to this works with other frontends/backends, head over to the [RealWorld](https://github.com/gothinkster/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
[](https://glitch.com/edit/#!/remix/realworld-moleculer)
#### 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. In this case you need to use a transporter i.e.: [NATS](https://nats.io). NATS is a lightweight & fast message broker. Download it and start with `gnatsd` command. After it started, set the `TRANSPORTER` env variable and start services.
```
TRANSPORTER=nats://localhost:4222
```
### To get the Node server running locally with Docker
1. Checkout the repo `git clone https://github.com/ice-services/moleculer-realworld-example-app.git`
2. `cd moleculer-realworld-example-app`
3. Start with docker-compose: `docker-compose up -d`
It starts all services in separated containers, a NATS server for communication, a MongoDB server for database and a [Traefik](https://traefik.io/) reverse proxy
4. Open the http://docker-ip:3000
5. Scale up services
`docker-compose scale api=3 articles=2 users=2 comments=2 follows=2 favorites=2`
## Code Overview
### Dependencies
- [moleculer](https://github.com/ice-services/moleculer) - Microservices framework for NodeJS
- [moleculer-web](https://github.com/ice-services/moleculer-web) - Official API Gateway service for Moleculer
- [moleculer-db](https://github.com/ice-services/moleculer-db/tree/master/packages/moleculer-db#readme) - Database store service for Moleculer
- [moleculer-db-adapter-mongo](https://github.com/ice-services/moleculer-db/tree/master/packages/moleculer-db-adapter-mongo#readme) - Database store service for MongoDB *(optional)*
- [jsonwebtoken](https://github.com/auth0/node-jsonwebtoken) - For generating JWTs used by authentication
- [bcrypt](https://github.com/kelektiv/node.bcrypt.js) - Hashing user password
- [lodash](https://github.com/lodash/lodash) - Utility library
- [slug](https://github.com/dodo/node-slug) - For encoding titles into a URL-friendly format
- [nats](https://github.com/dodo/node-slug) - [NATS](https://nats.io) transport driver for Moleculer *(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](https://github.com/agrison/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](https://tldrlegal.com/license/mit-license).
## Contact
Copyright (c) 2016-2017 Ice-Services
[](https://github.com/ice-services) [](https://twitter.com/MoleculerJS)