Skip to content

Commit

Permalink
Formatting of readme
Browse files Browse the repository at this point in the history
  • Loading branch information
davidmerfield committed Oct 17, 2018
1 parent 945e736 commit c183cf2
Showing 1 changed file with 35 additions and 25 deletions.
60 changes: 35 additions & 25 deletions app/readme.txt
Expand Up @@ -3,34 +3,44 @@ App

This directory contains all the code for the Node.js application which handles requested proxied by NGINX. It's basically a big Express.js application.


Inside this folder
------------------

blog
exposes an Express.js application for serving blogs, rendering pages
build
exposes methods to convert a file on disk into a blog post
clients
expose a list of clients, like 'Dropbox' or 'Git', which themselves expose methods to:
- write and remove files to and from a blog's folder
- synchronise a blog's folder
dashboard
exposes an Express.js application responsible for the dashboard, which where the user configures aspects of the blog.
helper
exposes a list of utility functions
models
wrapper around the database
site
exposes an Express.js application responsible for the documentation and public-facing site
status_page
exposes an Express.js application which keeps tabs on another site. Should not be running on the same server as the main Node.js application for obvious reasons.
sync
exposes methods which help the clients emit events, like a
templates
contains all of Blot's included templates

index.js
composes all of the features in the above directories and exposes it!
blog
exposes an Express.js application for serving blogs, rendering pages

build
exposes methods to convert a file on disk into a blog post

clients
expose a list of clients, like 'Dropbox' or 'Git', which themselves expose methods to:
- write and remove files to and from a blog's folder
- synchronise a blog's folder

dashboard
exposes an Express.js application responsible for the dashboard, which where the user configures aspects of the blog.

helper
exposes a list of utility functions

models
wrapper around the database

site
exposes an Express.js application responsible for the documentation and public-facing site

status_page
exposes an Express.js application which keeps tabs on another site. Should not be running on the same server as the main Node.js application for obvious reasons.

sync
exposes methods which help the clients emit events, like a

templates
contains all of Blot's included templates

index.js
composes all of the features in the above directories and exposes it!



Expand Down

0 comments on commit c183cf2

Please sign in to comment.