hireable

Available-for-hire badge built with tremendous help from these guys and ☕
hireable.me is sponsored by @nguyenph88. Thank you so much for making it possible!

Usage

Copy this code and paste it into README (or README.md) in your project:

[![Is <username> available for hire?](http://hireable.me/<username>)](http://hireable.me/p/<username>)

Want to use this badge on your website? Here is the HTML version:

<a href="http://hireable.me/p/<username>">
  <img src="http://hireable.me/<username>" alt="Is <username> available for hire?" />
</a>

You hate this style? Try others by modifying the URL of the badge as follow:

http://hireable.me/<username>/<style>

<username> is a GitHub username
<style> is a supported style

Current supported styles

• default (null)
• flat
• Others will be added soon

But why?

Some of my friends want to embed the employment status into their open-source projects. But it takes too much time and effort to keep these information up-to-date across projects.
I thought it would be much cooler to tell people whether you're hireable or not with a badge.

The badges

Default

Flat

badges/shields Specification is no longer on our road map. All styles are pre-generated.

• Q: How do you know when I'm hireable?
  A: Your GitHub jobs profile

Roadmap

• Customizable styles: Released - v0.2.0
• On-the-fly badges: W̶o̶n̶'̶t̶ ̶b̶e̶ ̶i̶m̶p̶l̶e̶m̶e̶n̶t̶e̶d̶
• Remove Koa & related libraries: Released - v0.3.0-rc.1
• Styling using request parameters: Released - v0.3.0-rc.3

Quickstart Installation

• Download the latest release here

# Unzip
unzip hireable-v*.zip -d hireable && cd hireable

# Dependencies
npm install --production

# Config. See #configurations
vim config/production.json

# Environment
export NODE_ENV=production

# Serve
npm run serve

# You may also want to try pm2 or forever instead
# pm2 start lib/index.js --name=hireable

Configurations

Hireable uses node-config

Configurations are stored in configuration files within your application, and can be overridden and extended by environment variables, command line parameters, or external sources.

Default configurations

{
    "Hireable": {
        "port": "1406"
    },
    "GitHub": {
        "token": ""
    },
    "Cache": {
        "maxAge": 0,
        "promise": true
    },
    "Badge": {
        "images": {
            "yes": "yes.svg",
            "no": "no.svg",
            "error": "error.svg"
        },
        "style": "default",
        "directory": "../styles"
    },
    "User": {
    }
}

Development

• But first, give me a ⭐. Thank you 😆

git clone https://github.com/hiendv/hireable.git && cd hireable
npm install
npm run dev

# Create a release?
npm run build && ls build

Testing

npm test

Contribution

Issues and PRs are welcome !