# What is Upvotex?
Upvotex is an innovation feedback platform. That helps you collect and manage all of your user feedbacks in one place. Switching from you THINK to you KNOW.
## How it works?
#### 1. Gather product feedback
Get feedback publicly on a dedicated feedback board. Shorten the gap between your customer's actual needs and the service that your business is offering.
Vote to change. Identify the most popular ideas by the amount of vote for each feedback.
#### 2. Share your Roadmap
It's time to bring ideas to life. A roadmap is where you can communicate with your customer about the upcoming features. By sharing what you're working on, you get more trust from your customer, maintaining customer relationships.
#### 3. Notify product update
After getting feedback and roadmapping. It's time to announcing new features and bug fixes in Changelog to close your customer feedback loop.
## Why Upvotex?
* Fast and confident decision making
* Communicate channel for customer
* Reduce the risk of product failure
* Real-customer insights
* Connect and build customer relationship
* Manage feedbacks in one place
# Installation
It is super easy to install Upvotex on your website. Follow these simple Getting Started instructions to begin.
## **1- Uploading**
#### *Step 1: Downloading.*
After purchasing from Codecanyon, go straight to **My Account > Download Items**. Then download **Upvotex** to your computer.
#### *Step 2: Uploading.*
You will need to upload the downloaded zip file to your **hosting folder** and then **extract** the zip file.
Congratulations, you have just completed uploading Upvotex with a few easy steps.
## 2- Installing
#### ***Step 1: Begin.***
To install, you'll need to access this URL by replacing it with your website domain https\://***Your Website Domain***/upvotex/.
This will prompt the Welcome panel. Click on **LET'S GO!**
#### ***Step 2**: **Database information.***
Fill in your **database connection details** and click on **CONTINUE**
{% hint style="info" %}
Suppose you're not sure about this information. Please contact your hosting provider for this inquiry.
{% endhint %}
#### ***Step 3: Create an admin account.***
Sign up for an admin account and click on **COMPLETE INSTALLATION**
{% hint style="info" %}
If you were facing the error, as shown below. Please follow this guide to solve it.
{% endhint %}
First, you need to access your **website folder** through **cPanel**. Then you'll find the **Upvotex** folder.
Click-on it and find the file named as **.env** to change its permissions from **0664** to **0777.** To change, click on the **permission number**, and keep in mind to **save** after change**.**
> If you found any error while installing Upvotex. Please contact our support for more assistance.
# Users
Users are where you can manage all of the registered accounts. Set role, add or block users.
# All users
From the Dashboard, click on **Users** > **All users.**
* **ADD NEW:** Instantly add new user.
* **FILTER:** Sort your user with the alphabet order and account status.
* **SEARCH:** Quick search with keywords.
# Add a new user
From the **Dashboard**, go to **Users** > **New user.**
1\. Fill in all **required fields**.
2\. Select a relevant **Badge** for your new user.
3\. Assign a specific **Role.**
4\. Click on **New User** button to complete.
# All badges
All badges is where you can manage all of your created badges.
From the Dashboard, click on **Users** > **All badges.**
* **ADD NEW:** Instantly add a new badge.
* **ALPHABET FILTER:** Sort your badge in alphabet order.
* **SEARCH:** Quick search with keywords.
# Add a new badge
From the Dashboard, click on **Users** > **New badge.**
1\. Fill in the **Name Of Badge.**
2**.** Select **Badge Colo**r by dragging in the color panel.
3\. Hit on **CREATE NEW BADGE** to complete the final step.
# Posts
A post is an object that represents an idea posted to a board. They are always associated with a user and a board. Users can vote on them
# All Posts
From the **Dashboard**, go to **Posts** > **All posts.**
* **ADD NEW:** Instantly add new user.
* **FILTER:** Sort posts with the alphabet order and post category.
* **SEARCH:** Quick search with keywords.
# Add a new post
From the **Dashboard**, go to **Posts** > **New post.**
1\. Fill in the new post **Title** and **Description.**
2\. On the **Displayed Status**, assign a status for the new post**.**
3\. Select the relevant board for the new post on **Boards.**
4\. Set the post privacy on **Access Type.**
5\. Finally, hit on **NEW POST** to complete.
# Status
Status Shows A State Of Post. Statuses Are Displayed On Boards After Title Of Post. Statuses Are Also Used As Columns On Roadmaps, Each Column Contains Posts Of The Same Status.
# All Status
From the **Dashboard**, go to **Status** > **All status.**
* **ADD NEW:** Instantly add new status.
* **FILTER:** Sort status with the alphabet order.
* **SEARCH:** Quick search with keywords.
# Add new status
From the **Dashboard**, go to **Status** > **New status.**
1\. Fill in the **Name Of Status.**
2**.** Select **Status Colo**r by dragging in the color panel.
3\. Hit on **CREATE NEW STATUS** to complete the final step.
# Boards
Boards are where your users discuss and give feedback for a particular topic. As an Admin, you can manage, add, or remove boards.
# All boards
From the Dashboard, select **Boards** > **All Board.**
* **ADD NEW:** Instantly add or edit new board.
* **ALPHABET FILTER:** Sort your board in alphabet order.
* **SEARCH:** Quick search with keywords.
# Add a new board
From the Dashboard, click on **Boards** > **New board.**
1\. Fill in your **board title.**
2\. Select the **Access Type** for your new board.
3\. Hit on **CREATE NEW BOARD** to complete the final step.
# Roadmap
Roadmap Is A Virtual Desk Split By Columns. Each Column Displays Posts With Particular Status. Posts On Roadmap Can Be Limited By Board Or Tags.
# All roadmaps
From the Dashboard, select **Roadmaps** **>** **All Roadmaps.**
* **ADD NEW:** Instantly add or edit new roadmap.
* **ALPHABET FILTER:** Sort your roadmap in alphabet order.
* **SEARCH:** Quick search with keywords.
# Add a new roadmap
From the Dashboard, go to **Roadmaps > New Roadmap.**
1\. Fill in the new roadmap **Title** and **Description.**
2\. On the **Displayed Status**, assign status for the new roadmap**.**
3\. Select the relevant board on **Boards.**
4\. Set the roadmap privacy on **Access Type.**
5\. Finally, hit on **CREATE NEW ROADMAP** to complete.
# Changelogs
A changelog is simply a list of entries where you point out to your customers that your product is constantly improving. Or simply make an announcement.
# All posts
From the Dashboard, select **Changelogs** **>** **All Posts.**
* **ADD NEW:** Instantly add or edit new changelog.
* **ALPHABET FILTER:** Sort your changelog in alphabet order.
* **SEARCH:** Quick search with keywords.
# Add a new post
From the **Dashboard**, go to **Changelogs > New Post.**
1\. Fill in the new changelog **Title** and **Content.**
2\. Assign it with a relevant status from the **Displayed status.**
3\. Set the post privacy on **Access Type**.
4\. (Optional) uploading **thumbnail** for the post.
5\. Finally, hit on **CREATE NEW CHANGELOG** to complete.
# Changelog Settings
### 1. **Access type:**
* **Public:** Allow access to all users.
* **Verified:** Only verified users have access to this changelog.
* **Private:** Only the admin can see and access this changelog.
### 2. **Show on homepage:**
* Display/ hide **all** changelogs on the homepage.
{% hint style="info" %}
This is the privacy level of the entire changelog. Yet, you can always tighten security for a particular post.
{% endhint %}
# Comments
Users and admins can always leave comments on posts. Therefore, comment objects are always associated with a post.
From the Dashboard, select **Comments.**
* **SEARCH:** Quick search with keywords.
* **ACTION:** Edit or Delete comments.
# Settings
Follow the listed steps to configure your setting. Personalize Upvotex to appropriate your brand identity.
# General
From the Dashboard, select **Settings** > **General.**
1\. **Upload Logo**: your brand logo in png or jpg format**.**
2\. **Upload Favicon**: the image that appears next to the site name.
3\. Set the site **Title** and **Description**.
4\. Change the **Theme Color** based on your brand identity.
5\. Customize your **Front Size** and **Front Family.**
5\. Finally, hit on **SAVE CHANGE** to complete.
# Email
Setting up SMTP for the email system.
1\. From the Dashboard, select **Settings** > **Email.**
2\. Type in your Email information and click on **SAVE CHANGE.**
**Mail Host:** Fill in your SMTP server address.
**Mail Username:** Your email address.
**Mail Password:** Your app password.
**Mail From Name:** Set the sender name.
{% hint style="success" %}
If you don't know how to get your APP Password. Please follow this [instruction](https://support.google.com/accounts/answer/185833?hl=en).
{% endhint %}
3\. Check if your SMTP is working by sending a **Test Email** to your email.
4\. Check your mail inbox.
5\. Customize the email content.
{% hint style="danger" %}
The {{$body}} field is required in the email template to deliver the relevant content for each type of email. Please don't delete it!
{% endhint %}
6\. Click on **SAVE CHANGE** to complete.
# Google API
Configure the Google API for user login with Google Account.
1\. From the Dashboard, select **Settings** > **Google API.**
{% hint style="info" %}
If you knew how to get your own Google API, you can skip this step and fill in your **Google Client ID** and **Google Client Secret**. Conversely, if you wonder how to get these pieces of information, please follow this instruction below.
{% endhint %}
2\. Firstly, click [**here**](https://console.developers.google.com/apis) and login with your **Google accoun**t.
3\. Click on the **OAuth consent screen** tab, select **External**, then hit on **CREATE**.
4\. Fill in all required information and click on **SAVE AND CONTINUE**.
5\. After completing all the above steps, you'll then end up on the **Summary** page, where you can double-check your information and able to edit it.
6\. Go back to the dashboard and then click on the **Credentials tab**. On the top center, you'll find the **Create credentials** button.
Click on that button and select **OAuth client ID** and **Web application** as an Application type. And, start to fill in the **Name** of your OAuth client.
Add your **Authorized redirect URLs** with the form as described below.
Click on **CREATE** when you complete
{% hint style="danger" %}
Your redirect URL must follow this form: .\*\* It can't be Callback or CALLBACK.
{% endhint %}
7\. Copy **Your Client ID** and **Your Client Secret** to fill in your Google API setting.
8\. After you finish, Switch on **Enable Google Login** and click on **SAVE CHANGE.**
9\. To ensure your Google API works properly. Click on **TEST API** to test.
# Google reCAPTCHA
Keep malicious software from engaging in abusive activities on your website.
1\. From the Dashboard, select **Settings** > **Google reCAPTCHA.**
2\. Click [**HERE**](https://www.google.com/recaptcha/about/) to redirect to the Google reCAPTCHA site.
3\. Click on **Admin Console.**
4\. Start to **register a new site** by fill the registration form.
{% hint style="warning" %}
Upvotex only works with the reCAPTCHA v2.
{% endhint %}
5\. Type in your email address and click on **SUBMIT.**
6\. You've just successfully added reCAPTCHA to your domain. Copy the **SITE KEY** and **SECRET KEY** to paste on the Google reCAPTCHA settings.
7\. Test your CAPTCHA to see if it works properly.
