My Pantry - Fullstack app for tracking items across multiple locations.
- Ruby 87.5%
- Dockerfile 6.1%
- Shell 5.8%
- HTML 0.6%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
| api | ||
| ui | ||
| .gitignore | ||
| README.md | ||
MyPantry
A full-stack application to manage and track grocery and other household items accross multiple storage locations with a Rails 8 API backend and a Typescript frontend.
Techstack
Frontend
- Framewrork: Typescript
- Test Framework: Jest
Backend
- Rails Version: 8.0.5
- Ruby Version: 3.4.3
- Database: Postgresql 17
- Project Type: Rails API
- Test Framework: RSpec
Project overview
This application allows a user to:
- Track various household items accross multiple storage locations
- Track the quantity of each item and its location
- Track expiration dates for perishable items
Project structure (proposed)
.
├── api/ # Rails 8 API Backend
│ ├── app/
│ │ ├── controllers/ # API and authentication controllers
│ │ └── models/ # Itemand Location models
│ ├── spec/ # RSpec tests
│ ├── db/migrations/ # Database migrations
│ └── README.md # Backend setup guide
├── ui/ # Typescript Frontend
│ ├── app/ # Typescript pages
│ ├── components/ # TypescriptReact components
│ ├── contexts/ # TypescriptContext for state management
│ ├── lib/ # API service and utilities
│ └── README.md # Frontend setup guide
└── README.md # This file
create Rails 8 API
rails new api --api --database postgresql --skip-git --skip-test
Create Typescript app
npm install typescript --save-dev