https://github.com/aeksco/magellan

Client-side ontology-driven filesystem knowledge capture and faceted search
https://github.com/aeksco/magellan

Last synced: over 1 year ago
JSON representation

Client-side ontology-driven filesystem knowledge capture and faceted search

• Host: GitHub
• URL: https://github.com/aeksco/magellan
• Owner: aeksco
• License: mit
• Created: 2017-03-06T21:14:42.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2018-10-01T05:19:52.000Z (over 7 years ago)
• Last Synced: 2025-01-23T03:46:01.849Z (over 1 year ago)
• Language: CoffeeScript
• Homepage: https://aeksco.github.io/magellan/
• Size: 7.57 MB
• Stars: 1
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
## Magellan

#### Ontology-driven Lightweight Faceted Browser & Knowledge Capture Utility

##Built with:

- [Jade](http://jade-lang.com/)

- [SASS](http://sass-lang.com/)

- [Gulp](http://gulpjs.com/)

- [BS4 (Alpha)](http://v4-alpha.getbootstrap.com/)

- [Font-Awesome](http://fortawesome.github.io/Font-Awesome/icons/)

- [Underscore.js](http://underscorejs.org/)

- [Backbone.js](http://backbonejs.org/)

- [Marionette.js](http://marionettejs.com/)

## Directory Structure Breakdown

###### Note: some auto-generated top-level directories have been ommitted for brevity.

##### Top Level

- **app/** --- client application

- **gulp/** --- build tasks

- **platforms/** --- Cordova platforms

- **plugins/** --- Cordova plugins

- **Gulpfile.coffee** --- build configuration

- **package.json** --- dependency management

- **config.xml** --- Cordova configuration

##### app/

- **img/** - Images (only stores logo.png)

- **sass/** --- SASS & style dependencies

- **coffee/** --- CoffeeScript source files

##### app/coffee

- **behaviors/** --- Behaviors

- **components/** --- Components

- **config/** --- Configuration files

- **modules/** --- Modules

- **services/** --- Services

- **manifest.coffee** --- manifest

- **app.coffee** --- Application class

##### app/coffee/behaviors

###### Behaviors are view mixins used in both Components and Modules.

##### app/coffee/components

###### Components are routeless services with views that are accessible anywhere in the application.

  - **component_name**/ --- Each Component in a separate directory

    - **component.coffee** --- Component controller

    - **views/** --- Component views

      - **layout.coffee**

      - **templates/** --- Component templates

        - **component.jade**

##### app/coffee/config

###### Configuration files for Cross-Origin Requests (CORS), JSON Web Token (JWT), and Marionette.js

##### app/coffee/modules

###### Modules represent collections of endpoints in the application. They always have a Router and at least one Route, and often have Models, Collections, and Services.

###### NOTE: The complexity of directory structure in Modules and Components may seem redundant, but the opinions enforced by this structure work effectively to ensure scalability of the application from a development perspective.

  - **module_name**/ --- Each Module in a separate directory

    - **route_01/**

      - **views/** --- Route views

        - **layout.coffee**

        - **templates/** --- Route templates

          - **module.jade**

    - **route_02/**

    - **.../** --- (modules can have many routes)

    - **collection.coffee** --- Backbone.Collection

    - **model.coffee** --- Backbone.Model

    - **router.coffee** --- Router

    - **service.coffee** --- Service

##### app/coffee/services

###### Services are workers that are available to perform specific background tasks. They are _routeless_, and they neither maintain nor manage any views.