Skip to content

vergissberlin/andrelademann-de-express

Repository files navigation

⭐ ⭐ ⭐ andrelademann.de ⭐ ⭐ ⭐

Coverage Status Build Status Build Status Scrutinizer Code Quality Codacy Badge BlackDuck Badge NSP Status

What

This is the repository to my personal homepage andrelademann.de. I decided to make the source code public for two reasons. Firstly to inspire other people to create there own Website with Node.js and secondly to give pros the chance to find and report bugs and security voluntaries.

Used technologies

Server site

Node.js, Express, Handlebars, Grunt, Mongoosejs ODM, MongoDB, S3 Image upload, CloudFront CDN, imagemagick, SASS

Development and deployment

Webstorm, herokuapp app build and hosting, Travis CI, Scrutinizer,

Client site

HTML5, Bootstrap 4 alpha CDN Version, font awesome, RDF, vCard, Microformats, Open Graph, Twitter card, Syntax highlighting with prism, Comments with Disqus

Milestones

Waffle.io - Columns and their card count To see the current status, take a look in the milestones overview page or the on waffle.io board.

Milestone #01 - Setup and static page

Milestone #02 - Blog

  • Simple custom CMS for blog articles
  • Rss Feed /Atom Feed
  • Open Graph Support http://ogp.me/
  • Twitter Card support
  • Automatic enhanced content - TinyMCE Plugin for FREME

Milestone #03 - Projects and blog improvements

Contributing

Stories in Ready Please report bugs and security gaps. My promis: For every bug that you find within my source code and report it, I give an hour for your project. Thanks! 👍 Fee free to contact me on Gitter Greenkeeper badge.

Installation

  1. Clone the repository
  2. Type npm install to install the dependencies
  3. Start a mongodb database an configure the credentials in config/database.js
    • docker-compose -f docker-compose.yml -f docker-compose.development.yml up -d
  4. Set the Environment variables
    • NODE_ENV=development
    • AWS_ACCESS_KEY_ID=foo
    • AWS_SECRET_ACCESS_KEY=foo
    • S3_BUCKET=foo
  5. Type npm start to start a local web server

Optional settings

  • Set the Environment variables
    • MONGODB_URI=foo (To override configuration file settings)
    • NODE_SECRET=foo
    • AUTH_SECRET=foo
    • BASE_USER=foo (For basic authentication)
    • BASE_SECRET=foo (For basic authentication)
    • AWS_REGION=foo
    • BUGSNAG_TOKEN=foo To monitor bug messages.

Documentation