Skip to content
This is a dedicated repository for the User Interface (Front End) components of the Aardwolf Project :)
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
design_notes
templates
web
LICENSE
README.md
ui-spec.txt

README.md

aardwolf-interface

This is a dedicated repository for the User Interface (Front End) components of the Aardwolf Project :)

Ideally the interface being built here should be able to stand on its own. This allows developers to play around, and test out ideas without having to build the full rust project. Once the visual components have been vetted, they will of course need to be "backported" into the main repository which is here: Aardwolf-Social.

One of the goals of the project overall is to keep it simple, and secure. That means trying to minimize the use of iFrames, JavaScript, and other scripting languages. Thankfully HTML5, and the primary element library Bulma.io are able to provide dynamic layouts using only HTML, and CSS. Additionally, icons provided by ForkAwesome (a FOSS alternative to that other popular icon library), is also free of JavaScript.

Banjo had another note planned for this, but he can't think of what the heck it was supposed to be. Probably because he got distracted watching television.

Directory Structure
There are two primary directories for the app templates which houses the bulk of the HTML files, and web which is where the styling, and static assets go.

templates/      -- Template root (template base, un-authenticated templates go here)
├── asides      -- Left-hand menus
├── email       -- Email templates
├── home        -- Templates for logged-in users (main content, top nav, footer, etc.)
├── posts       -- Templates related to user posts (new post, reply, etc.)
└── widgets     -- Reusable elements (text/password inputs, buttons, etc.)
web
├── _sass           -- SASS files (SCSS syntax)
│   ├── base            -- Global SCSS 
│   ├── external        -- reset.scss (and similar)
│   ├── includes        -- footer, header
│   └── layouts         -- structural styles (Bulma, and overrides)
│
├── emoji           -- Emoji images (future planning)
├── images          -- Static images
├── javascript      -- JavaScript files (if needed)
├── static          -- Other static files
│
├── css             -- Compiled CSS
│   ├── fonts          -- Font files for Forkawesome
│   └── forkawesome    -- Fork Awesome CSS (Not included)
│
└── themes          -- Theme files (future planning)

Developer Resources

InVision
Wireframes have been posted to InVision, which can also be used for advanced prototyping:
InVision - Aardwolf Wireframes

CodePen
Banjo also has a CodePen account here:
CodePen

You can’t perform that action at this time.