Skip to content

Latest commit

 

History

History
99 lines (69 loc) · 3.08 KB

README.md

File metadata and controls

99 lines (69 loc) · 3.08 KB
Raw

💌 Altruist

Gateway micro service for sharing content with ease ✌️

❓Why

Altruist is a bridge to a pletory of services. It acts as a server. All the wiring hard work has been done, no more:

  • manual coding of social services API,
  • reading outdated docs for each services you want to use,
  • comparing and finding the right module,
  • developing a new custom lib for a specific service.

It focuses on Social Network and File SAAS and it abstract the internal differences of all of this services.

If you need to share with one of the following services, then 💌 Altruist is for you.

Simply connect your prefered account through the web server altruist provide and post your data to 💌 Altruist.

All the APIs have been meticulously integrated to respond to the same form of media POST to 💌 Altruist.

Currently 💌 Altruist supports the following data form POST:

  • application/json raw
  • application/x-www-form-urlencode
  • multipart/form-data

image

🌍 Installation as a binary

Install the tool:

$ yarn global add altruist
# or
$ npm install -g altruist

then, provide a settings file:

# get the template
$ wget https://raw.githubusercontent.com/soixantecircuits/altruist/master/settings/settings.default.json
# rename it
$ mv settings.default.json settings.json
# start altruist web server
$ altruist --settings settings.json

For details about what to write in the settings file, See the Actions section below.

Then, from a server, an app or POSTMAN you can post to:

POST http://localhost:6060/api/v1/actions/{ACTION_NAME}

👋 Usage

One action = one service

List of available actions:

⚠️ Some actions may require that you log in before using them. You can get a list of those actions with their login url by sending a GET request to the url matching authRedirect in the settings file (/authRedirect by default).

🕳 Troubleshoot

POSTMAN + MULTER

You can meet some issue while uploading file and JSON. This is a bug in POSTMAN. See here: postmanlabs/postman-app-support#2602 A way to fix it is to close and reopen the tab you are using to test the query. (http://stackoverflow.com/questions/35851660/multer-req-file-always-undefined/38461398#38461398)

❤️ Contribute

Thanks for helping us! 👏

Please follow:

Please use the develop branch if you want to contribute.