Skip to content

Illyism/Avalon

Repository files navigation

Getting Started

Get node (from package-manager) and npm if not installed together.

You'll also need grunt to compile lesscss and run a watcher for livereload.

  > npm install
  > npm install -g grunt-cli 

  Then start with
  > bin/www
  or
  > npm start

  And to compile, just run
  > grunt

Structure

App.js loads everything. It refers to routes defined in the /routes folder. The routes serve content immediately or refer to the controllers for more logic.

Jade views are in /views. There is a layout.jade that each page renders and a directory for /includes. You can set title, description, keywords in the block head as you can see in /views/help/index.

For design, take a look at public/styles.html in a browser, but it's still in HTML and not jade for now. You'll get an idea of what you can do with each class.

Style

  • Use 2 spaces.

Making Emails

  1. Copy one of the files in /library/emails/default
  2. Edit as you wish
  3. Run grunt email in this directory.
  4. Your file is in public/emails/xxx.html

Links

About

🔪 Avalon Node.js Web Server

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published