Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/evenchange4/micro-medium-api

Microservice for fetching the latest posts of Medium with GraphQL.
https://github.com/evenchange4/micro-medium-api

apollo-server docker graphql graphql-tools medium micro microservice now pkg zeit

Last synced: 3 months ago
JSON representation

Microservice for fetching the latest posts of Medium with GraphQL.

Host: GitHub
URL: https://github.com/evenchange4/micro-medium-api
Owner: evenchange4
License: mit
Created: 2017-08-07T11:43:41.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2018-01-15T01:34:59.000Z (about 7 years ago)
Last Synced: 2024-10-15T08:35:46.871Z (3 months ago)
Topics: apollo-server, docker, graphql, graphql-tools, medium, micro, microservice, now, pkg, zeit
Language: JavaScript
Homepage: https://micro-medium-api.now.sh/graphiql
Size: 220 KB
Stars: 140
Watchers: 3
Forks: 18
Open Issues: 18
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

awesome-list-microservice - micro-medium-api

README

        # Micro-medium-api

> Microservice for fetching the latest posts of Medium with GraphQL.

>

> Further reading: [\[中文\] Microservice 產品交付 - Dockerize 與 Zeit JavaScript 跨平台解決方案](https://medium.com/@evenchange4/microservice-%E7%94%A2%E5%93%81%E4%BA%A4%E4%BB%98-9f2954c7167d)

[![Travis][travis-badge]][travis]

[![Codecov Status][codecov-badge]][codecov]

[![Github Tag][githubTag-badge]][githubTag]

[![node][node]]()

[![Dependency Status][dependency-badge]][dependency]

[![devDependency Status][devDependency-badge]][devDependency]

[![peerDependency Status][peerDependency-badge]][peerDependency]

[![Greenkeeper badge][greenkeeper-badge]][greenkeeper]

[![prettier][prettier-badge]][prettier]

[![license][license-badge]][license]

## Feature

- Use GraphQL.

- Dataloader for per-request memory cache.

- Rate-limiting 1 requests per sec.

## How To Use

### a. Deploy to Now.sh

> One click deploys to △ now

[![Deploy to now](https://deploy.now.sh/static/button.svg)](https://deploy.now.sh/?repo=https://github.com/evenchange4/micro-medium-api&env=ORIGIN)

### b. Binary executable

Download from GitHub [latest release](https://github.com/evenchange4/micro-medium-api/releases/latest).

```

$ ORIGIN=$YOUR_DOMAIN \

  ./micro-medium-api-macos --port $PORT

```

> Note: You can run it without Node.js installed.

### c. Docker image

Pull from [dockerhub][dockerhub].

[![Docker Automated build][dockerhub-auto-badge]][dockerhub]

[![Docker Pulls][dockerPulls-badge]][dockerhub]

[![Docker Size][dockerSize-badge]][dockerSize]

```

$ docker pull evenchange4/micro-medium-api:latest

$ docker run --rm -it \

  -p $PORT:3000 \

  -e "ORIGIN=YOUR_DOMAIN" \

  evenchange4/micro-medium-api:latest

```

### d. NPM CLI

 

Install from [npm][npm].

 

[![npm downloads][npm-downloads]][npm]

[![npm][npm-badge]][npm]

 

```

$ npm i micro-medium-api -g

 

$ ORIGIN=$YOUR_DOMAIN \

  micro-medium-api --port $PORT

```

 

> Note: You should use Node.js >= 8 .

## API

### Environment variables

| **ENV**   | **Required**  | **Default**  | **Description** |

| --------- | --------- | --------- | --------- |

| `ORIGIN`  |  | `*` | Setup `access-control-allow-origin` for CORS. |

### CLI arguments

```

$ micro-medium-api --help

Usage: micro-medium-api  [options]

 

Options:

  -p, --port     HTTP server PORT                                [default: 3000]

  -h, --help     Show help                                             [boolean]

  -v, --version  Show version number                                   [boolean]

```

### GraphQL endpoint

- [GET] /graphql

- [POST] /graphql

## Demo

- [GraphiQL](https://micro-medium-api.now.sh/graphiql)

- [HTTP GET example](https://micro-medium-api.now.sh/graphql?query=query%20PostQuery(%24username%3A%20String!%2C%20%24limit%3A%20Int)%20%7B%0A%20%20posts(username%3A%20%24username%2C%20limit%3A%20%24limit)%20%7B%0A%20%20%20%20title%0A%20%20%20%20firstPublishedAt%0A%20%20%20%20url%0A%20%20%20%20subtitle%0A%20%20%7D%0A%20%20%0A%20%20user(username%3A%20%24username)%20%7B%0A%20%20%20%20username%0A%20%20%20%20name%0A%20%20%20%20bio%0A%20%20%7D%0A%7D&variables=%7B%0A%20%20"username"%3A%20"evenchange4"%2C%0A%20%20"limit"%3A%20100%0A%7D)

- Real-World case:  [michaelhsu.tw](https://michaelhsu.tw/) [[source code](https://github.com/evenchange4/michaelhsu.tw)]

> Note: You should deploy your own service for production usage.

## Technology Stacks

- [Micro](https://github.com/zeit/micro): Asynchronous HTTP microservices.

- [Micro-router](https://github.com/pedronauck/micro-router): A tiny and functional router for Zeit's Micro.

- [Micro-ratelimit](https://github.com/dotcypress/micro-ratelimit): Rate-limiting middleware for micro.

- [Graphql-tools](https://github.com/apollographql/graphql-tools): 🔧 Build and mock your GraphQL.js schema using the schema language.

- [Graphql-server-micro](https://github.com/apollographql/apollo-server/tree/master/packages/graphql-server-micro): 🌍 GraphQL server

- [Dataloader](https://github.com/facebook/dataloader): DataLoader is a generic utility to be used as part of your application's data fetching layer to provide a consistent API over various backends and reduce requests to those backends via batching and caching.

- [Dockerhub][dockerhub]: Automatically deploy docker image.

- [Now.sh](https://zeit.co/now): Realtime global deployments

- [Pkg](https://github.com/zeit/pkg): Package your Node.js project into an executable

- Travis: CI

## Developer Guide

### Requirements

-   node >= 8.5.0

-   npm >= 5.3.0

-   yarn >= 1.0.2

```

$ git clone https://github.com/evenchange4/micro-medium-api.git

$ yarn install --pure-lockfile

$ yarn run dev # dev server

$ yarn start   # prod server

$ yarn run pkg # output binary files

```

### Test

```

$ yarn run format

$ yarn run eslint

$ yarn run test:watch

```

### Docker

```

$ docker build -t micro-medium-api .

# Push to dockerhub

$ git push

```

> Note: Multi-stage builds are a new feature in Docker 17.05.

 

### Github release / NPM release

 

```

$ npm version patch

$ git push

```

 

## Inspiration

- https://github.com/enginebai/PyMedium

## CONTRIBUTING

*   ⇄ Pull requests and ★ Stars are always welcome.

*   For bugs and feature requests, please create an issue.

*   Pull requests must be accompanied by passing automated tests (`$ yarn run test`).

## [CHANGELOG](CHANGELOG.md)

## [LICENSE](LICENSE)

MIT: [http://michaelhsu.mit-license.org](http://michaelhsu.mit-license.org)

[travis-badge]: https://img.shields.io/travis/evenchange4/micro-medium-api/master.svg?style=flat-square

[travis]: https://travis-ci.org/evenchange4/micro-medium-api

[codecov-badge]: https://img.shields.io/codecov/c/github/evenchange4/micro-medium-api.svg?style=flat-square

[codecov]: https://codecov.io/github/evenchange4/micro-medium-api?branch=master

[node]: https://img.shields.io/node/v/micro-medium-api.svg?style=flat-square

[npm-badge]: https://img.shields.io/npm/v/micro-medium-api.svg?style=flat-square

[npm]: https://www.npmjs.com/package/micro-medium-api

[npm-downloads]: https://img.shields.io/npm/dt/micro-medium-api.svg?style=flat-square

[dependency-badge]: https://david-dm.org/evenchange4/micro-medium-api.svg?style=flat-square

[dependency]: https://david-dm.org/evenchange4/micro-medium-api

[devDependency-badge]: https://david-dm.org/evenchange4/micro-medium-api/dev-status.svg?style=flat-square

[devDependency]: https://david-dm.org/evenchange4/micro-medium-api#info=devDependencies

[peerDependency-badge]: https://david-dm.org/evenchange4/micro-medium-api/peer-status.svg?style=flat-square

[peerDependency]: https://david-dm.org/evenchange4/micro-medium-api#info=peerDependencies

[githubTag-badge]: https://img.shields.io/github/tag/evenchange4/micro-medium-api.svg?style=flat-square

[githubTag]: ./CHANGELOG.md

[license-badge]: https://img.shields.io/github/license/evenchange4/micro-medium-api.svg?style=flat-square

[license]: http://michaelhsu.mit-license.org/

[greenkeeper-badge]: https://badges.greenkeeper.io/evenchange4/micro-medium-api.svg

[greenkeeper]: https://greenkeeper.io/

[dockerhub-auto-badge]: https://img.shields.io/docker/automated/evenchange4/micro-medium-api.svg?style=flat-square

[dockerhub]: https://hub.docker.com/r/evenchange4/micro-medium-api/

[dockerPulls-badge]: https://img.shields.io/docker/pulls/evenchange4/micro-medium-api.svg?style=flat-square

[dockerSize]: https://microbadger.com/images/evenchange4/micro-medium-api

[dockerSize-badge]: https://images.microbadger.com/badges/image/evenchange4/micro-medium-api.svg

[prettier-badge]: https://img.shields.io/badge/styled_with-prettier-ff69b4.svg?style=flat-square

[prettier]: https://github.com/prettier/prettier