atul9 / acehelp

AceHelp makes online help docs contextual

AceHelp

AceHelp makes online help docs contextual.

Install dependencies

• node(8+)

Local Development setup

./bin/bundle install

# Database setup and populate sample data
cp config/database.yml.postgresql config/database.yml

brew install elasticsearch
brew services start elasticsearch

./bin/rails setup

./bin/yarn install

npm install -g elm

elm-package install -y

rake searchkick:reindex:all

foreman start -f Procfile.dev

Once we see webpack: Compiled successfully. message in terminal, we can visit the app at http://localhost:3000.

To create data e.g. Article, URLs etc. you must login as a user. To login as a user, please visit http://localhost:3000/users/sign_in

# Login info
[email protected] / welcome

Webpack will automatically compile if a file inside app/javascript/ directory is modified in development mode.

GraphQL is enabled

Once servers are up and running, visit localhost:3000/graphql/playground to play around GraphQL queries and mutations.

Visit https://github.com/bigbinary/acehelp/tree/master/docs/graphql-examples to see some examples of how to use GraphQL.

Heroku Review

Heroku Review is enabled on this application. It means when a PR is sent then Heroku automatically deploys an application for that branch.

Continuous deployment when PR is merged to master

Whenever PR is merged to master then master code is automatically deployed to http://staging.acehelp.com.

Working example

Visit the following link to view AceHelp in action https://careforever-for-acehelp.herokuapp.com/

About BigBinary

AceHelp is maintained by BigBinary. BigBinary is a software consultancy company. We build web and mobile applications using Ruby on Rails, React.js, React Native and Elm.