OpenDash

OpenDash is Twimbit's platform for Account Based Marketing Management. It acts as an extension to the existing CMS capabilities to handle complex functions and organise information.

Tech Stack

• Frontend: HTML5, CSS3, JavaScript, Amp, JQuery, JQuery UI
• Backend: WordPress

Getting Started

System Requirements

You will be needing the following to support your development environment.

• Git
• mySQL
• Linux Based Terminal, if you're using Windows and installed with Git.
• Google Chrome or a decent latest web browser.
• Any Text Editor: Vim, Terminal, VS Code, etc.

Installation Instructions

WordPress Installation

• Download Xampp

• Set up Apache Server and MySQL in the Xampp Control Panel

• Download WordPress

• Copy the extracted WordPress folder and Paste it to .../Xampp/htdocs/

• Open Chrome and type localhost/phpmyadmin

• Create and configure a new database

• Type localhost/<your downloaded wordpress folder name>/

• Complete the WordPress installation by following the steps mentioned on the website

  • Default WordPress username: root

  • Default WordPress password: <no password>

• Configure the WordPress with site name, custom username and password

• Submit Install WordPressand Login with your custom credentials.

  WordPress is installed and configured. You should be able to access your Dashboard.

Theme Installation

• Clone the following theme and paste it under .../Xampp/<Your Wordpress folder name>/wp-content/themes

  • OpenDash theme

• Activate the theme underWordpress Dashboard > Appearance

  Theme is installed and activated. You should be able to see them in your Dashboard

Plugins Installation

• As this includes, automation, plugins will automatically be installed under Wordpress and can be seen under WordPress Dashboard > Plugins

• Additionally, clone the following plugin and paste them under .../Xampp/<Your Wordpress folder name>/wp-content/plugins

  • pdf-js twimbit
  • WP Mail SMTP by WPForms

• Go to Wordpress Dashboard > Private Content > Settings and configure accordingly

• Go to Wordpress Dashboard > Page > New Page and configure accordingly

  Plugins are installed and activated. You should be able to see them in your Dashboard

Additional Installations

• Install WP Webhooks

  • Go to Wordpress > Settings > WP Webhooks

  • Go to Settings in Wp Webhooks and Activate the Triggers and Actions accordingly and save them

  • go to Receive data and copy the link from Webhook URL

All the resources are installed and activated

You are now ready to contribute to the OpenDash project.

Contribution Guidelines

• Please read our Code of Conduct and Gitflow for contributing towards the project.
• Write clear meaningful git commit messages (Do read this).
• Make sure your PR's description contains GitHub's special keyword references that automatically close the related issue when the PR is merged. (Check this for more info)
• When you make very very minor changes to a PR of yours (like for example fixing a text in button, minor changes requested by reviewers) make sure you squash your commits afterwards so that you don't have an absurd number of commits for a very small fix. (Learn how to squash at here)
• When you're submitting a PR for a UI-related issue, it would be really awesome if you add a screenshot of your change or a link to a deployment where it can be tested out along with your PR. It makes it very easy for the reviewers and you'll also get reviews quicker.
• Always create PR to develop branch.

Mentors

GitHub Usernames	Domain
Aman Sharma (@amanintech)	Full Stack
Siddhant Kumar (@siddhantdante)	Full Stack