{"id":22989073,"url":"https://github.com/megamsys/verticegateway","last_synced_at":"2025-08-13T20:33:43.626Z","repository":{"id":7710209,"uuid":"9075226","full_name":"megamsys/verticegateway","owner":"megamsys","description":"REST API server with built in auth,  interface to ScyllaDB/Cassandra","archived":false,"fork":false,"pushed_at":"2017-08-18T11:58:12.000Z","size":5145,"stargazers_count":24,"open_issues_count":2,"forks_count":34,"subscribers_count":14,"default_branch":"1.5.2","last_synced_at":"2024-04-11T00:06:30.853Z","etag":null,"topics":["api","cassandra","megam","nsq","scala","vertice"],"latest_commit_sha":null,"homepage":"https://www.megam.io","language":"Scala","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/megamsys.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-03-28T10:55:24.000Z","updated_at":"2024-04-11T00:06:30.854Z","dependencies_parsed_at":"2022-09-02T10:01:18.423Z","dependency_job_id":null,"html_url":"https://github.com/megamsys/verticegateway","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/megamsys%2Fverticegateway","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/megamsys%2Fverticegateway/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/megamsys%2Fverticegateway/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/megamsys%2Fverticegateway/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/megamsys","download_url":"https://codeload.github.com/megamsys/verticegateway/tar.gz/refs/heads/1.5.2","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":229780088,"owners_count":18122920,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","cassandra","megam","nsq","scala","vertice"],"created_at":"2024-12-15T04:16:08.919Z","updated_at":"2024-12-15T04:16:09.507Z","avatar_url":"https://github.com/megamsys.png","language":"Scala","funding_links":[],"categories":[],"sub_categories":[],"readme":"Vertice Gateway\n================\n\nThis is our API server for [MegamVertice](https://www.megam.io) `1.5.x or \u003c 2.0 release`.\n\n# Roadmap for 2.0\n\nAPI server for 2.0 is based on [rust](https://www.rust-lang.org/en-US/) connecting to [cockroachdb](https://www.cockroachlabs.com/docs/secure-a-cluster.html). \n\n## Where is the code for 2.0\n\nWe have moved the development to private gitlab as it will have enterprise features.\n\n## When can i get it in my anxious hands\n\n`2.0` will be released on `Sep 30 2017` or less.\n\n## Requirements to compile from source\n\n\n1. [SBT 0.13.11 \u003e](https://scala-sbt.org)\n2. [NSQ 0.3.x  ](http://nsq.io)\n3. [OpenJDK 8.0](http://openjdk.java.net/install/index.html)\n4. [Cassandra 3 +](http://apache.cassandra.org)\n\nThe API server protects the RESTful resources using\n\n- [HMAC](http://www.ietf.org/rfc/rfc2104.txt) based authorization.\n- PASSWORD based on PBKDF2\n- Master key\n\n## Compile from source\n\nYou'll need `sbt` build tool. and `OpenJDK8.0`\n\n### Fork\n\nAfter you have forked a copy of https://github.com/megamsys/vertice_gateway.git\n\n### Steps\n\n```\n\n* git clone https://github.com/\u003cyour_github_id\u003e/vertice_gateway.git\n\n* cd vertice_gateway\n\n* sbt\n\n* clean\n\n* compile\n\n\n```\n\n## Running\n\n[Install Cassandra](http://cassandra.apache.org/download/)\n\n[Install NSQ.io](http://nsq.io/deployment/installing.html)\n\n\n## Setup cassandra keyspace\n\n```\n* cd vertice_gateway/db\n\n* cqlsh -f base.cql\n\n* cqlsh -f 1.5.cql\n\n* cqlsh -f 1.5.1.cql\n\n* cqlsh -f 1.5.2.cql\n\n* cqlsh -f ee.cql\n\n* cqlsh -f me.cql\n\n```\n\n## MEGAM_HOME\n\nCreate a home directory to store configuration files for MegamVertice\n\n```\n\n$ cd ~\n\n$ mkdir -p megam/home/verticegateway\n\n```\n\nEdit your `.bashrc`\n\nIn your .bashrc file add the following line\n\n```\n\nexport MEGAM_HOME=$HOME/megam/home\n\n```\n\nAfter this enter save the .bashrc file.Use the following command\n\n  source ~/.bashrc  \n\n## Configuration\n\nCopy configuration files to $MEGAM_HOME/verticegateway\n\n```\n\n$ cd vertice_gateway (your cloned location)\n\n$ cp conf/gateway.conf $MEGAM_HOME/verticegateway\n\n$ cp conf/logger.xml $MEGAM_HOME/verticegateway\n\n\n```\n\n## Start Vertice Gateway\n\n```\n* cd vertice_gateway\n\n* sbt\n\n* clean\n\n* compile\n\n* run\n\n```\n\n![Gateway](https://github.com/megamsys/vertice_gateway/blob/1.5/public/images/vertice_gateway.png)\n\n## Type the url `http://localhost:9000`\n\nYou'll see this in your browser.\n\n```json\n{\n  \"status\" : {\n    \"casssandra\" : \"up\",\n    \"nsq\" : \"down\"\n  },\n  \"runtime\" : {\n    \"total_mem\" : \"975 MB\",\n    \"freemem\" : \"649 MB\",\n    \"cores\" : \"4\",\n    \"freespace\" : \"399 of 450 GB\"\n  }\n}\n\n```\n\nNow you are all set.\n\n# API Documentation\n\nRefer [docs](https://docs.megam.io] and we'll publish vertice.raml shortly.\n\nTo generate the html docs.\n\n```\n\nnpm install -g raml2html\n\nraml2html vertice.raml\n\n```\n\n\n# Contribution\n\nAs this is heavy on memory, we have a work in progress 2.0 code which is based on rust.\n\n# Documentation\n\nFor [documentation] (http://docs.megam.io)  [devkit] (https://github.com/megamsys/vertice_dev_kit)\n\n# License\n\nMIT\n\n\n# Authors\n\nMegam - Humans (\u003chumans@megam.io\u003e)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmegamsys%2Fverticegateway","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmegamsys%2Fverticegateway","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmegamsys%2Fverticegateway/lists"}