Sha256: 9f92219d3befd12edfde2ec1c80a3bd8f442265354905c66968a3497adb178f8
Contents?: true
Size: 1.25 KB
Versions: 3
Compression:
Stored size: 1.25 KB
Contents
# HubSpot-ruby sample app
# HubSpot-ruby timeline-events sample app
This is a sample app for the [hubspot-ruby SDK](../../../../../). Currently, this app focuses on demonstrating the functionality of [Timeline Events API](https://developers.hubspot.com/docs-beta/crm/timeline) endpoints and their related actions.
Please see the documentation on [Creating an app in HubSpot](https://developers.hubspot.com/docs-beta/creating-an-app)
### HubSpot Public API links used in this application
- [Search for contacts](https://developers.hubspot.com/docs-beta/crm/contacts)
- [Create event template](https://developers.hubspot.com/docs-beta/crm/timeline)
- [Create timeline event](https://developers.hubspot.com/docs-beta/crm/timeline)
### Setup App
Make sure you have [Docker Compose](https://docs.docker.com/compose/) installed.
### Configure
1. Copy .env.template to .env
2. Specify authorization data in .env:
- Paste HUBSPOT_CLIENT_ID and HUBSPOT_CLIENT_SECRET for OAuth
### Running
The best way to run this project (with the least configuration), is using docker compose. Change to the webroot and start it
```bash docker-compose up --build web```
You should now be able to navigate to [http://localhost:3000](http://localhost:3000) and use the application.
Version data entries
3 entries across 3 versions & 1 rubygems