SMPLog is a Markdown-based minimalist blog application. It has been developed with a mobile-first point of view, and works well on any device.

1. Clone the repo: git clone https://github.com/kiswa/SMPLog
2. Install dependencies: npm i
3. Build and minify SMPLog: gulp && gulp minify

After building, the dist directory has all the files needed to run SMPLog. Copy it to wherever you want it and start using SMPLog.

Note: If you are using SMPLog in a sub-directory (e.g. yoursite.tld/blog), you will need to update the index.html file in dist. Change the <base href="/">, to use your base location (in this case, it would be <base href="/blog/">).

If you want to develop on SMPLog, you can run gulp watch and changes will be built automatically.

By default, SMPLog uses SQLite for the database. However, you can use just about anything. Take a look at the documentation for RedBeanPHP and change line 5 of api/index.php to use the setup you prefer.

Go to the url for your install with admin added to the end. For example, http://example.com/blog/admin. The first time, you can log in with the username admin and password admin.

It is recommended you then visit the Settings link and change your password.

While in Settings, the admin user can change the title of the blog, set the background image for the header section, and update the description used in the RSS feed.

All users can change their displayed name and author image. Password changing is also always available.

The New Post tab allows you to enter a new post using Markdown, with a live preview next to it. When on mobile, the preview appears beneath the new post form.

The admin user is the only one that can create and remove other users, and update the Blog Details (these sections do not display for standard users). There is only one admin user.

Removing a user sets them as inactive, and all posts by that user are marked unpublished. The user and posts still exist in the database. The admin user can manage this, and re-instate a user and their posts.

It is worth mentioning that the short text displayed on pages where posts are listed is created by pulling the first paragraph of text from the post. This means if the first thing in your post is # Some Header Text, then the short text will be Some Header Text and not the first actual paragraph.

If you plan to develop SMPLog, you will need to update the base href in src/index.htmlto <base href="/dist/"> and comment out the enableProdMode() line in main.ts to get Angular debug output.

This project was made possible by the following open source projects:

• Angular
• Bourbon & Neat - A few handy mixins and responsive grid system
• Font Awesome - Font icons, of course
• highlight.js - Syntax highlighting for the Web
• marked - A fast JavaScript Markdown parser
• scss-base - Minimal clean styles for SCSS projects

• Slim - A PHP micro framework to quickly write powerful web apps and APIs
• RedBeanPHP - An ORM-like tool to easily store objects in a database
• PHP-JWT - A simple library to encode and decode JSON Web Tokens in PHP
• Markdown - A super fast markdown parser for PHP (used to generate RSS)

Because I find it interesting, even if it's not a good metric.

cloc --exclude-dir=vendor,lib --exclude-ext=json src/

cloc --exclude-ext=xml test/

Last updated Dec. 15, 2016