Skip to content

Latest commit

 

History

History
210 lines (153 loc) · 9.34 KB

README.md

File metadata and controls

210 lines (153 loc) · 9.34 KB
Raw

Wotify dashboards

Organize hackaton ideas into a dashboard

HackDash Logo

Wotify Logo

Special version suited for the Europeana Wotify Dashboards

Install

This is a heavily modified fork of hackdash to convert this originally showcase style web to a workin tool.

Some of the changes introduced are:

  • Allowing different themes by overwriting .hbs or .less files.
  • Added a complex Form creator tool by the dashboards admins to make leaders respond questions during the hackaton.
  • Login by email and google added.
  • Added more configuration options for dashboards (for example a private mode prevents projects in that dashboard to appear publicly in the web).
  • Notifications by email works.

Config

You can copy the sample data and edit your values:

cp config/config.json.sample config/config.json

In this copy of hackdash, statuses can be customized, you need to create a copy of statuses.json inside the config folder as well. Use the sample as default:

cp config/config.json.sample config/config.json

In your config/config.json:

  • db:
    • url: Overrides other db config. Full MongoDB URL.
    • host
    • port
  • host: Your instance host (i.e. yourdomain.com)
  • port: Your port (i.e. 3000)
  • session: Your session key (it must be a secret string)
  • title: Instance title used in the html title tag and other headings.
  • image: Url for the default image in metas properties. Leave null for default.
  • live: Boolean (true, false) that enable/disable the live feed feature in yourdomain.com/live.
  • mailer: SMTP mail info to enable email notifications using nodemailer. Check out the options
  • mailerFrom: "Some name noreply@example.com" REQUIRED if mailer is used, this is the default from used in email comunications
  • team: An array of user._id to be shown as Team on Landing Page.
  • maxQueryLimit: a Number for the max amount of results at the landing page searchs.
  • googleAnalytics: the UA-XXXXXXXX-X code from Google Analytics. if not specified wont set the script.
  • googleApiKey: The Google Maps API Key for geolocation purposes
  • facebookAppId: the Facebook App Id for share buttons. It will take first from keys.json, if not will use this one. Don't set it to not show FB share buttons.
  • prerender:
    • enabled: Boolean (true, false). Where the website would use the SEO Prerender
    • db: The Mongo URI of Cached Pages.

Added vars for Wotify Dashboards:

  • defaultHomeTab: By default Hackdash takes the user to the "dashboards" tab in the homepage. This allows to change it by any of these values: "dashboards", "projects", "users", "collections".
  • homeTabOrder: One of: "first_created", last_created", "random" (last_created by default)
  • publicHost: and alternative public host can be specified here (used in several links to return home, i.e: wotify.co). This is useful in case you run your node app behind a proxy in a different port than 80 (Please specify protocol (http://example.com or better https://example.com).
  • publicDashboardCreation : a boolean to specify if dashboards can be created by anyone or just the users with permission "dashboard_create"
  • homeCreateProject : Set it to true in order to show a button in the front page to create projects
  • useLocalLogin: Set to true if you want to allow username/password registration
  • theme: This allows to apply a custom themes to hackdash. Just put a theme_name with the same folder name inside themes/theme_name. Styles or hbs templates can be overwritten. (Look at the code inside themes for an example).
  • language: If null autodetects from user's browser settings. Otherwise specify a valid lang to force Hackdash to that lang (ie: en, es)
  • languages: An object with a list of valid languages to be listed as an option for the user ie: {"en" : "EN", "es" : "ES"},
  • maxUploadSize: Max upload size for file uploads (defaults to 2M),
  • skills: List of user profiles skills (if empty none shown)
  • internalComments: Use internal comments instead of disqus or discourse
  • commentsTypes: If internal comments are used, a categorization of the comments can be specified by this array

Login keys setup

Logins are only available through 3 th party services. You'll need to create Apps and obtain the secrets from those services (currently Twitter, Facebook, Github and Google). We've added Google login tot the keys.

User the keys.json.sample as an example. Google login uses Oauth2.0 version.

cp config/keys.json.sample config/keys.json

Local login (traditional username/password) can be added by setting "useLocalLogin": true in config.js

Roles setup

Roles are introduced with atomic permissions (more on this later on this document)

cp config/roles.json.sample config/roles.json

Init test server

npm start

Generate Client scripts

This step is necessary if you make changes in the CSS or the client code (folder client)

cd client
grunt

For convenience, both can be started at the same time:

npm run devel

If using themes, theme must be compiled in grunt as well. Theme is readed from configuration config/config.json. Grunt task also accepts a --config option to compile using a different config file (useful if you are working in more than one theme).

cd client
grunt --config ../config/config.json

Generating collections

node scripts/collections.js

Managing users and roles

Roles has been introduced, any number of roles can be defined. There are a collection of simple permissions.

Change roles with:

node scripts/users.js

Roles config

Roles are collections of atomic permissions. Current permissions are:

  • user_update: Permission to update others users data (except role)
  • user_change_role: Permission to change user role
  • comment_project: TODO: when a custom comment forum
  • project_create: Permission to create a new project.
  • project_view: Permission to view private projects (without being admin of the dashboard).
  • project_edit: Permission to edit others projects.
  • project_follow: Permission to follow others projects.
  • project_join: Permission to join other projects as contributor.
  • project_update: Permission to update others projects (except dashboard). Requires to be admin in that dashboard (project owner has this permission anyway).
  • project_delete: Permission to delete others projects. Requires to be admin in that dashboard (project owner has this permission anyway).
  • project_change_dashboard: Permission to change project's dashboard. Requires to be admin in that dashboard.
  • form_results: Permission to view forms responses for a project. Requires to be admin in that dashboard (project owner has this permission anyway).
  • form_respond: Permission to answer forms for a project. Requires to be admin in that dashboard (project owner has this permission anyway).
  • TODOform_create: Permission to create new forms in a dashboard or collection. Requires to be admin in that dashboard or collection).
  • TODOform_update: Permission to edit existing forms in a dashboard or collection (form owner has this permission anyway). Requires to be admin in that dashboard or collection).
  • TODOform_delete: Permission to delete existing forms in a dashboard or collection (form owner has this permission anyway). Requires to be admin in that dashboard or collection).
  • dashboard_create: Permission for creating dashboards
  • dashboard_view_private: Permission to view projects in private dashboards (dashboard owner has this permission anyway). Requires to be admin in that dashboard
  • dashboard_set_private: Permission to change dashboard status. Requires to be admin in that dashboard
  • dashboard_set_status: Permission to change dashboard status. Requires to be admin in that dashboard
  • dashboard_set_open: Permission to change open/close dashboard availability (dashboard owner has this permission anyway). Requires to be admin in that dashboard
  • dashboard_set_showcase: Permission to edit the showcase dashboard (dashboard owner has this permission anyway). Requires to be admin in that dashboard

Roles can be customized by editing config/roles.json.

TOKENS

Tokens that allows role authentication can be assigned in the database user's entry to use bearer authentication on the API endpoints.

There's no yet an interface for easy token management, however it can be manually assigned using the command scripts/users.js:

node scripts/users.js -u {USERID} -t 'My token'

It will return the token UUID (ex: b0e318d-0fe0-4e50-99f2-6a4883229ddd).

This token can be used as a replacement authentication method for the user by using the Authentication: Bearer {TOKEN} HTTP header.

For example, using CURL:

curl -H "Authorization: Bearer b0e318d-0fe0-4e50-99f2-6a4883229ddd" localhost:3000/api/v2/projects

Contribute

The original wiki guide is here (hopefully):

Feel free to make contributions to this copy of Hackdash if somehow is useful for you.