Clear My Spam is an open source Ruby on Rails app designed to declutter your Gmail inbox, with an emphasis on simplicity, usability, and security.

https://clearmyspam.com

• Ruby on Rails >= 7.2.1.1
• Overmind - Used to run the web and background job servers.

• Ruby on Rails
• Hotwire
• PostgreSQL
• Tailwind CSS
• Tailwind UI
• Render (for hosting)

1. Clone the repository.
2. Install Ruby on Rails (if you haven't.)
3. Run bundle install to install Rails dependencies and npm install to install Hotwire.
4. Run rails db:setup to create a development database and run migrations.
5. Delete development.yml.enc and development.key from config/credentials/ and replace them with your own (Ruby on Rails Guide).

   # Gmail, Stripe, and Honeybadger credentials are optional. Without them, you may see some errors when running tests.
   google:
     client_id: <client_id>
     client_secret: <client_secret>
   gmail:
     mailer_password: <gmail_app_password>
   stripe:
     api_key: <stripe_api_key>
     weekly_price_id: <stripe_weekly_price_id>
     monthly_price_id: <stripe_monthly_price_id>
   honeybadger:
     api_key: <honeybadger_api_key>

6. Use overmind to run the app locally + debug.

   # Use this command to start the web server, background job server, and live reloading for ERB + Tailwind changes.
   overmind start -f Procfile.dev
   
   # If you want to connect to the web server or background job server separately for debugging, use these commands.
   overmind connect web
   # good_job is Clear My Spam's background job backend of choice for async email deletion.
   overmind connect good_job

7. Run tests with rails test.