hellowin / kanca

Facebook Group Analytics
https://hellowin.github.io/kanca/
MIT License
33 stars 12 forks source link
bithound community community-engagment community-management facebook facebook-graph-api facebook-groups facebook-login flow github-page

Kanca logo

Build Status codecov Known Vulnerabilities Codacy Badge Code Climate

Kanca is an application to analyze Facebook Group activity. Its key features are:

Local Development

Requirements

  1. Node.js 6+
  2. Facebook Developer's Application, create it at https://developers.facebook.com for free
  3. Make sure you enabled Facebook Login feature and put http://localhost:3000 exist in your Valid OAuth redirect URIs (Facebook Login -> Settings)

Installation

  1. Go to project root directory, copy .env.template to .env (edit it as you need, look at description below)
  2. Install its dependencies $ npm install or $ yarn install

IDE/ Text Editor/ OS Configuration

Since this project uses Flow, and some environment specific configuration, some IDE or Text Editors needs additional configuration.

Windows

Please use Bash on Ubuntu on Windows or Windows Subsystem Linux for local development.

VSCode

Add "javascript.validate.enable": false on your VSCode config (.vscode/settings.json).

It would be better if you install this Flow plugin as well.

Development

  1. Run $ npm start or $ yarn start
  2. Open browser at http://localhost:3000

Environment Variable Explanation

Roadmap

To track development progress and roadmap, follow this GitHub Project.

License

MIT