No packages found.
simple and elegant support system
Help shouldn't hurt
Nothing special found.
Help shouldn't hurt.
Helpful is an open product that's being built by a fantastic group of people on Assembly. Anybody can join in building this product and earn a stake of the profit.
If you're running Windows, here's a guide written by one of our members on how to get set up.
Vagrant is the recommended way to run Helpful on your own machine. You need to download and install Vagrant before you can continue (this will take a while to run so you may want to grab some coffee).
git clone https://github.com/asm-helpful/helpful-web.git helpful-web cd helpful-web vagrant up
Once it's finished open up http://localhost:5000 in your web browser to check out Helpful.
Remember that you are using Vagrant, so if you run
bundle install or
rake db:migrate directly in your terminal it will not affect the virtual machine where Helpful is running.
In order to run these commands, in the virtual machine, all you have to do is to run
If you need to change any environment variable you have to edit
.env file properly and restart Rails server running:
vagrant ssh -c "sudo restart helpful"
To create a new account for Helpful, click "Sign Up" on the homepage.
In your .env file, change the below values for your own email and
USE_GMAIL=true SENDER_EMAIL_ADDRESS="ema[email protected]" SENDER_EMAIL_PASSWORD="PassWord"
Save and restart the app (
sudo restart helpful on vagrant)
Setting up Mailgun in development takes a little work but allows you to use the
actual email workflow used in production.
rake mailgun:create_routeand when prompted enter your Ngrok address as the domain name.
There are a couple of steps you need to take before contributing:
Then just go ahead, fork the repo & issue a pull request. You're on your way to having a stake in Helpful.