https://github.com/geut/pell
Create P2P based microservices with zero configuration.
https://github.com/geut/pell
hapi microservice p2p
Last synced: 5 months ago
JSON representation
Create P2P based microservices with zero configuration.
- Host: GitHub
- URL: https://github.com/geut/pell
- Owner: geut
- Created: 2016-11-18T18:07:13.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-03-27T10:45:39.000Z (almost 9 years ago)
- Last Synced: 2025-09-26T08:47:41.052Z (6 months ago)
- Topics: hapi, microservice, p2p
- Language: JavaScript
- Size: 20.5 KB
- Stars: 3
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Create Microservices
Create P2P based microservices with no configuration
:warning: **Project at early stage. Some things may not be working as expected**
## tl;dr
__Package is not published yet. Below is the expected way of work/usage. You can still clone and `npm link`it.__
```sh
npm install -g geut@create-microservice
create-microservice my-service
cd my-service/
npm start
```
*Note*: Default port is 3000. If is in use, the generator will lookup for a different one.
## Getting Started
### Installation
Install it once globally:
```sh
npm install -g pell@create-microservice
```
**You’ll need to have Node >= 6 on your machine**.
**We strongly recommend to use Node >= 6 and npm >= 3 for faster installation speed and better disk usage.** You can use [nvm](https://github.com/creationix/nvm#usage) to easily switch Node versions between different projects.
### Creating a Microservice
To create a new microservice, run:
```sh
create-microservice my-service
cd my-service
```
It will create a directory called `my-service` inside the current folder.
Inside that directory, it will generate the initial project structure and install the transitive dependencies:
```
.
├── index.js
├── node_modules
├── package.json
├── README.md
└── server.js
```
No configuration or complicated folder structures, just the files you need to build your microservice.
Once the installation is done, you can run some commands inside the project folder:
### `npm start`
Runs the microservice.
Currently we are using PM2 as the process manager.
### `npm test`
Runs your tests using [lab](https://github.com/hapijs/lab). The hapi testing framework.
### `npm run eject`
Builds the app for production to the `build` folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
## Philosophy
* **One Dependency:** There is just one build dependency.
* **Zero Configuration:** There are no configuration files or command line options.
* **No Lock-In:** You can “eject” to a custom setup at any time.
## Why Use This?
To explore a different and more lightweight (less stressful) approach to microservices.
## What’s Inside?
Currently we are using a small set of modules in order to get a P2P based approach to microservices.
* [discovery-swarm](https://github.com/mafintosh/discovery-swarm) Provides the service discovery layer.
* [hapiJS](http://hapijs.com/) The current implementation is about http(s) so hapi is a must-have.
* [ESLint](http://eslint.org/)
* and others.
All of them are transitive dependencies of the provided npm package.
## Contributing
TBD
## Inspiration
For this tool we follow almost the same approach [`create-react-app`](https://github.com/facebookincubator/create-react-app) project took.