wopo-cli v0.0.3

wopo-cli

The WOPO command line utility.

Instalation

npm i -g wopo-cli

Usage

After installation the wopo CLI tool will be available to you.

Create a new portfolio

wopo new portfolio my-awesome-portfolio

This will create a new folder my-awesome-portfolio and add the basic WOPO portfolio structure. After this you can modify portfolio.json which is located at my-awesome-portfolio/data. This command also supports a --theme (alias -t) option which will automatically create a new blank theme. portfolio.json supports properties listed below:

{
  "about": "",
  "title": "",
  "description": "",
  "keywords": "",
  "job_offers": true
}

wopo-cli.json supports properties listed below:

{
  "destDir": "dist",
  "themeDir": "theme",
  "host": "localhost",
  "port": "5000"
}

Create a new WOPO theme

wopo new theme

This will create a new blank theme in specified folder (by default it is theme but can be modified from wopo-cli.json) and add the basic WOPO theme structure. theme.json supports properties listed below: This command requires wopo-cli.json in execution folder.

{
  "name": "",
  "views": {
    "index": "views/index"
  },
  "gallery": [
    "gallery/screenshot.jpg"
  ],
  "cover": "cover.jpg"
}

Generate data files

wopo generate article my-awesome-article

This will generate an article named my-awesome-article. After it is generated you can edit your article from data/articles/my-awesome-article.json. article is an example here and can be replaced by any other available blueprint. Supported blueprints are: article, certificate, education, project, skill and work-experience. This command requires wopo-cli.json in execution folder.

Run the server

wopo serve

This will launch a server that will automatically rebuild your portfolio on file changes and by default serves at http://localhost:5000/. This command requires wopo-cli.json in execution folder.

License

This project is licensed under the MIT License.