Skip to content
Kevin da Silva edited this page Jul 3, 2021 · 1 revision

Welcome to the mongolia wiki!

Hello everyone!!

This is the first page of mongolia wiki, and I would like to say a few things about the project:

  1. We are an open source data gateway for mongodb, and the main idea was to be able to use mongodb operations through a rest api like many databases do nowadays to turn the database usable without depending on a good and documented driver for your favorite programming language
  2. We are welcome to contributors from everywhere, and here's the contribution guides:
    • You can easily start contributing by forking the repo
    • Then create your feature branch add-my-new-interesting-feature
    • After your feature is created, you should guarantee that the code coverage is at least 91% and with all the tests passing
    • Then open your PR and the maintainers will review your code and approve or point some improvements(we answer quick I promise :))
  3. The team:
    • The main and only maintainer is Kevin da Silva the current owner of the repository but as I said previously we are open to your contributions whatever it is
  4. Every time a pr is approved, a new version of the docker image is published here
  5. You can also run mongolia without docker just by running node index.js
  6. Looking for learning resources:
    • The full feature documentation can be found at the project read me
    • A get started article is also available on medium in the following link
  7. Stack:
    • We are currently using node.js(javascript), mongoose, joi, express, uuid, dotenv and jest for testing
Clone this wiki locally