Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/nibalizer/galileo

Snot Project
https://github.com/nibalizer/galileo

Last synced: 18 days ago
JSON representation

Snot Project

Awesome Lists containing this project

README

        

Galileo: a new snot project
===========================

Goals and Scope
---------------

The goal of the galileo project is to produce an alternate web application to snot. A Web Snot 2.0 if you will. This probably needs a better name. Plz2advise.

In an effort to reach this goal, serveral discrete components will be built. See 'subprojects'.

The primary requirement of this project is that it must be 100% compatible with the currently running snot. That means the snot database (flat files in /u/snot) are authoritative. Whenever possible, operations on this dataset will be done through traditional tooling. This means that both snot and galileo can run simultaneously.

Subprojects
-----------

Four parts:

boogerd2
--------

application to expose snot operations through REST

version 2 because kennobaka wrote version 1

snotrocket
----------

an application to speed up read and search operations

uses elasticsearch for cache

Mucus
-----

presentation layer: A website to present snot info and users to perform operations

uses jquery and ajax to make a "one page" app

pysnot
------

a library exposing common snot operations as python functions

nostrild
--------

an authentication and user information daemon
can provide authentication keys that can be used to hit other services

Tooling
-------

Right now most things are in python. But hopefully we can nail down the interfaces between the components and some of them can be written or rewritten in other languages.

Testing
-------

Right now there is some super limited testing. These tests are end to end test that directly modify testsnot. Making this better would be cool.

Naming
------

Nothing special is meant by the name galileo, it was unique and random. Subproject tooling names will be as hillarious as possible.

Development
-----------

If you just want to hack on mucus. Do this:

ssh -L 5001:localhost:5001 rita.cat.pdx.edu
firefox mucus/index.html

Hacking on the daemons, youll probably have to run them...

Contributing
------------

This project is in serious need of help. To find tasks you can ask on irc or git grep TODO. For contribution processes, read CONTRIBUTING.