Skip to content

Latest commit

 

History

History
121 lines (82 loc) · 3.17 KB

notes.md

File metadata and controls

121 lines (82 loc) · 3.17 KB

GearMate Startup Info

Notes file on various GearMate info.

Table of Contents

Notes

This README contains important information about setting up and troubleshooting the GearMate III Backend project.

Common Commands

Pruning Docker

  • docker system prune: Removes unused data
  • docker-compose restart backend: Restarts the backend service

Checking Environment Mode

  • console.log(import.meta.env.MODE);: Logs the current environment mode

Entering Docker Environment

  • docker exec -it gearmate_iii-backend-1 bash: Enters the backend container
  • docker exec -it gearmate_iii-backend-1 bin/rails db:migrate: Runs migrations
  • exit: Exits the container

Setting Up Postgres in Docker

  1. Enter the Docker environment:
  • docker exec -it gearmate_iii-backend-1 bash

  1. Run migrations: bin/rails db:migrate

  2. Exit the container:

  • exit
  1. To enter the Ruby console:
  • docker exec -it gearmate_iii-backend-1 bin/rails c

Environment Variables

In the client folder add .env.development

Add the following variable:

  • VITE_API_URL=http://localhost:3000

Root Directory (.env)

Add the following variables:

  • POSTGRES_USER=<yourname>
  • POSTGRES_PASSWORD=<password>

Common Setup Errors

Proxy Error

Frontend logs:

  • Error: connect ECONNREFUSED 127.0.0.1:3000 Console error: = UserApi.ts:5 GET http://localhost:5173/api/me net::ERR_ABORTED 500 (Internal Server Error)

Possible causes and solutions:

  1. Ensure the Vite proxy in vite.config is pointing to the correct path (localhost vs backend)
  2. Add this line to development.rb if missing
  • config.hosts << "backend"
  1. If having dependency issues in the frontend:
  • docker-compose exec frontend npm install

Searchkick commands

Enter the backend environment docker exec -it gearmate_iii-backend-1 bash

Reindex the Item being searched, for example, to reindex the Item model: rails searchkick:reindex CLASS=Item

For heroku: heroku run rails searchkick:reindex CLASS=Item --app gearmate

reindex in Heroku environment: heroku run rails searchkick:reindex CLASS=Item

Heroku Notes

Push to Heroku

  • git push heroku main

git subtree push --prefix backend heroku main

Enter Rails Console in Heroku Environment

  • heroku run rails console --app gearmate

If you want to look at attributes of an object, you need to add .attributes at the end of your method like so User.find(1).attributes

Run migrations in heroku environment. heroku run rake db:migrate

Searchkick and Elastic Search Helpful Commands

  • Ping elastic search from backend container:
    • curl http://elasticsearch:9200

Info on subdir heroku buildpack

https://elements.heroku.com/buildpacks/timanovsky/subdir-heroku-buildpack

Redis

Enter redis cli docker-compose exec redis redis-cli

Entering Ruby Console

  • docker exec -it gearmate_iii-backend-1 bin/rails c: Opens the Ruby console

View Development Logs

  • cd backend/log
  • shift+control+W
  • shift+control+V