Skip to content

pho-incubator/groups-frontend

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Grou.ps v2

A simple static page generator for Grou.ps v2 sites. Based on https://github.com/phonetworks/grou-ps-v2/releases/tag/php

Please note, this repo covers only the frontend components. For the backend, you need to install GraphJS-Server. GraphJS-Server can be run on your own servers, or it can be deployed in one-click to Heroku. For more information, check out GraphJS-Server README

Installation

For getting started, you just need to install the Node dependencies using NPM by typing in:

npm install

Usage

To generate a Grou.ps site, type in:

bin/generate {group_name} {group_title} --id {public_graphjs_id}

where:

  • group_name is a short ASCII string
  • group_title is the title of your site; may contain space and special characters.
  • public_graphjs_id is your GraphJS ID. You can fetch one from https://graphjs.com

Your site will be generated under dist/{group_name} ready to be served statically.

You may follow the steps shown at https://pages.github.com/ to host your site on Github for free.

License

MIT, see LICENSE.