https://github.com/amrdruid/salesforce-retail
https://github.com/amrdruid/salesforce-retail
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/amrdruid/salesforce-retail
- Owner: amrdruid
- Created: 2021-03-15T09:37:33.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-03-16T11:01:35.000Z (over 4 years ago)
- Last Synced: 2025-01-26T10:45:24.107Z (5 months ago)
- Language: Ruby
- Size: 54.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Salesforce Retail 👨💻
## Summary
Hey! This project helps managing your salesforce account by adding your customers and retails to your database, filtering them based on distance, and more future features that will allow getting the best out of the data you have
## Start the Project
If you have a Docker and docker compose . That's a good start. If not, here're the links to install them
Docker: https://docs.docker.com/get-docker/
Docker Compose: https://docs.docker.com/compose/install/
## Clone the project
`$ git clone [email protected]:amrdruid/Salesforce-Retail.git`
### Run docker build
`$ docker build .`
### Run docker compose to start the container
`$ docker-compose up`
### Run Sidekiq in another window
`$ docker-compose exec web bundle exec sidekiq`
### Run migrations
`$ docker-compose exec web bundle exec rake db:migrate`
### Add your salesforce credentials and secrets
Create an `application.yml` file using `docker-compose exec web bundle exec figaro install`
you can find a sample file in `application.yml.sample`
### Run the test suite
$ `rspec spec`
---
## Walkthrough
- From `dealers_controller.rb` we have two main APIs, `add_point_of_sales_dealers` and `dealers_within_range`
- `add_point_of_sales_dealers` allows adding retails to the database by internal employees
- `dealers_within_range` returns the retails around your current lng and lat in form of JSON
- We have a rake task that does what `add_point_of_sales_dealers` does. We can execute it through `docker-compose exec web bundle exec rake dealers:generate_and_save_to_db`
- We use `Sentry` for tracking errors
- We use `Figaro` gem to manage secrets
---
Areas for Improvement:
1- Add authorization
2- Possible caching when fetching dealers
3- Passing different categories to Sidekiq if we had other categories involved
4- Tests for models and routes, and one for the worker
---