npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

artic

v2.2.5

Published

Artic. It's for articles.

Downloads

75

Readme

Artic

Artic is a CMS for Articles, in node_modules form.

Status: [ ! UNSTABLE CONCOCTION ! ]

With minimal configuration:

  • Start up a server, utilizing Lance
  • Serve an admin iterface at http://*/artic
  • Create a sqlite database for persistance
    • Also supports postgres, mysql, mariadb
  • Artic remains a node module and does not impose a folder structure
  • Serves a modular template/theme frontend at http://*/
    • Populates a default template on instantiation

With further interfacing with Artic:

  • Utlize internal routers
  • Overwride internal controllers, handlers etc.
  • Modify database structure, extend models and stores

Artic is cleanly written and highly modular, focused on handling articles and not much else. You specify the dependencies you want Artic to use for your templates.

Because Artic is just another node module and is so modular, you can use as little or as much of it as necessary. Got your own server code? That's fine. Handling your own CSS compilation? Also fine.

See Lance for lower-level integration.

Data features

  • Articles
    • The highest level data structure.
  • Blocks
    • These make up an article.

Templates

Artic serves a template to the frontend, usually from
./<project directory>/templates/<template>

When you first start Artic that directory will be populated with the default template.

A template can contain a template.json:

{
	// Defaults to the directory name when not set
	"name"        : "MyTheme2"
,	"author"      : "nfour"
,	"description" : "Just a theme"
	
	// Files to be compiled to the public/static directory
	// See Lance templating for more information
,	"bundle": {
		"./css/destination.css" : "./source.styl"
	,	"./js/destination.js"   : "./app.coffee"
	}
}

All fields are optional.

Bundled files

Any bundled files in the template.json will be compiled and accessable from
/static/<template>/<destination path>.

{
	"bundle": { "dest/in/ation.css": "original/file.css" }
}

Can be referenced at. http://*/static/MyTheme2/dest/in/ation.css

Examples

npm install artic

Artic = require 'artic'

artic = new Artic {
	template: 'myTemplate'
}

artic.initalize().then -> # Done