Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hidakatsuya/shopping_list-web
A simple shopping list management application built with Rails8 and Hotwire and Tailwind CSS
https://github.com/hidakatsuya/shopping_list-web
hotwire propshaft rails tailwindcss turbo-rails
Last synced: 2 months ago
JSON representation
A simple shopping list management application built with Rails8 and Hotwire and Tailwind CSS
- Host: GitHub
- URL: https://github.com/hidakatsuya/shopping_list-web
- Owner: hidakatsuya
- License: mit
- Created: 2022-05-29T11:46:24.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-16T12:31:09.000Z (2 months ago)
- Last Synced: 2024-10-18T11:59:18.507Z (2 months ago)
- Topics: hotwire, propshaft, rails, tailwindcss, turbo-rails
- Language: Ruby
- Homepage:
- Size: 812 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Shopping List
[](https://github.com/hidakatsuya/shopping_list/actions/workflows/ci.yml)
A simple web application to manage shopping list.
It is built with [Rails8](https://github.com/rails/rails) and [Hotwire](https://hotwired.dev/) and [Tailwind CSS](https://tailwindcss.com/).
- Sign up and sign in with Google account
- Managing items on shopping list
- Updating the completion status of items
- Dark mode support
- Multiple language support
- API for adding items: `POST /items`
## Related Products
- [Shopping List Android](https://github.com/hidakatsuya/shopping_list-android): An Android client for Shopping List
- [Shopping List CLI](https://github.com/hidakatsuya/shopping_list-cli): A command line interface for Shopping List
## Built With
- Ruby 3.3
- Rails 8.0 beta
- Turbo (turbo-rails)
- Propshaft
- Tailwind CSS (tailwindcss-rails)
- SQLite
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
### Prerequisites
- Google OAuth Client
- Ruby or Docker
### Installing
Copy .env.sample to create .env, and set the client ID and secret key for Google OAuth client.
```
cp .env.sample .env
```
Then, execute the followings to launch the application.
```
./bin/setup
./bin/dev
```
Alternatively, you can launch the application in a Docker container.
```
docker compose build
docker compose run app bin/setup
docker compose up -d
```
## Running the tests
First, refer to the above and launch the application in a Docker container.
Runnning unit tests:
```
docker compose exec app bin/rails test
```
Running system tests:
```
docker compose exec app bin/rails test:system
```
Running all tests:
```
docker compose exec app bin/rails test:all
```
## Deploying to production using Kamal
Copy `.kamal/envs.sample` to create `.kamal/envs`, and set the environment variables for production.
Load the environment variables from `.kamal/envs` file.
```
source .kamal/envs
```
Run kamal to deploy.
```
kamal setup
```
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details