https://github.com/bloggify/bloggify

📝 We make publishing easy.
https://github.com/bloggify/bloggify

bloggify framework hacktoberfest nodejs publishing

Last synced: 4 days ago
JSON representation

📝 We make publishing easy.

• Host: GitHub
• URL: https://github.com/bloggify/bloggify
• Owner: Bloggify
• License: mit
• Created: 2014-04-27T04:38:23.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2024-11-04T11:37:26.000Z (about 2 months ago)
• Last Synced: 2024-12-11T12:23:08.386Z (11 days ago)
• Topics: bloggify, framework, hacktoberfest, nodejs, publishing
• Language: JavaScript
• Homepage: https://bloggify.org
• Size: 700 KB
• Stars: 26
• Watchers: 5
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# `$ bloggify`

 [![Version](https://img.shields.io/npm/v/bloggify-cli.svg)](https://www.npmjs.com/package/bloggify-cli) [![Downloads](https://img.shields.io/npm/dt/bloggify-cli.svg)](https://www.npmjs.com/package/bloggify-cli)

> We make publishing easy.

## :cloud: Installation

You can install the package globally and use it as command line tool:

```sh

# Using npm

npm install --global bloggify-cli

# Using yarn

yarn global add bloggify-cli

```

Then, run `bloggify --help` and see what the CLI tool can do.

```

$ bloggify --help

Usage: bloggify  [options]

We make publishing easy.

Commands:

  start  Starts the Bloggify process.

Options:

  -h, --help     Displays this help.

  -v, --version  Displays version information.

Examples:

  $ bloggify start

  $ bloggify start -c path/to/config/file.json

Documentation can be found at https://github.com/Bloggify/Bloggify.

```

## :clipboard: Example

Here is an example how to use this package as library. To install it locally, as library, you can use `npm install bloggify-cli` (or `yarn add bloggify-cli`):

```js

// This is how to include Bloggify as library.

const Bloggify = require("bloggify-cli")

// Start the Bloggify app

const app = new Bloggify("path/to/the/application/root")

// Do something after it's started

app.onLoad(err => {

    console.log(`Bloggify server running on port ${app._serverPort}`)

})

```

## :question: Get Help

There are few ways to get help:

 1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question.

 2. For bug reports and feature requests, open issues. :bug:

## :memo: Documentation

For full API reference, see the [DOCUMENTATION.md][docs] file.

## :yum: How to contribute

Have an idea? Found a bug? See [how to contribute][contributing].

## :dizzy: Where is this library used?

If you are using this library in one of your projects, add it in this list. :sparkles:

 - `bloggify-starter`

## :scroll: License

[MIT][license] © [Bloggify][website]

[license]: /LICENSE

[website]: https://bloggify.org

[contributing]: /CONTRIBUTING.md

[docs]: /DOCUMENTATION.md