Skip to content

Commit a94104e

Browse files
committed
refactor: Remove tailwindcss-rails dependency from Gemfile and Gemfile.lock
- Deleted the tailwindcss-rails gem from both Gemfile and Gemfile.lock to streamline dependencies. - Updated README.md to provide a more comprehensive setup guide and key design choices for the TIL Tracker application.
1 parent cc54b2b commit a94104e

File tree

3 files changed

+60
-36
lines changed

3 files changed

+60
-36
lines changed

Gemfile

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ gem "turbo-rails"
1515
# Hotwire's modest JavaScript framework [https://stimulus.hotwired.dev]
1616
gem "stimulus-rails"
1717
# Use Tailwind CSS [https://github.com/rails/tailwindcss-rails]
18-
gem "tailwindcss-rails"
1918
# Build JSON APIs with ease [https://github.com/rails/jbuilder]
2019
gem "jbuilder"
2120

Gemfile.lock

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -315,16 +315,6 @@ GEM
315315
stimulus-rails (1.3.4)
316316
railties (>= 6.0.0)
317317
stringio (3.1.6)
318-
tailwindcss-rails (4.2.2)
319-
railties (>= 7.0.0)
320-
tailwindcss-ruby (~> 4.0)
321-
tailwindcss-ruby (4.1.3)
322-
tailwindcss-ruby (4.1.3-aarch64-linux-gnu)
323-
tailwindcss-ruby (4.1.3-aarch64-linux-musl)
324-
tailwindcss-ruby (4.1.3-arm64-darwin)
325-
tailwindcss-ruby (4.1.3-x86_64-darwin)
326-
tailwindcss-ruby (4.1.3-x86_64-linux-gnu)
327-
tailwindcss-ruby (4.1.3-x86_64-linux-musl)
328318
thor (1.3.2)
329319
thruster (0.1.12)
330320
thruster (0.1.12-aarch64-linux)
@@ -382,7 +372,6 @@ DEPENDENCIES
382372
solid_cache
383373
solid_queue
384374
stimulus-rails
385-
tailwindcss-rails
386375
thruster
387376
turbo-rails
388377
tzinfo-data

README.md

Lines changed: 60 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,60 @@
1-
# README
2-
3-
This README would normally document whatever steps are necessary to get the
4-
application up and running.
5-
6-
Things you may want to cover:
7-
8-
* Ruby version
9-
10-
* System dependencies
11-
12-
* Configuration
13-
14-
* Database creation
15-
16-
* Database initialization
17-
18-
* How to run the test suite
19-
20-
* Services (job queues, cache servers, search engines, etc.)
21-
22-
* Deployment instructions
23-
24-
* ...
1+
# TIL Tracker
2+
3+
This is a simple "Today I Learned" (TIL) tracker application built with Ruby on Rails, following the 37signals development philosophy (minimal JS, server-rendered HTML, hand-crafted CSS).
4+
5+
It also serves as a self-referential job application, demonstrating core Rails skills.
6+
7+
## Ruby Version
8+
9+
- Ruby 3.2.2 (Managed via `rbenv`)
10+
11+
## System Dependencies
12+
13+
- PostgreSQL
14+
- `rbenv` (or similar Ruby version manager)
15+
- Bundler
16+
17+
## Setup
18+
19+
1. **Clone the repository:**
20+
```bash
21+
git clone [repository-url]
22+
cd ruby-app-37s/til_tracker
23+
```
24+
2. **Ensure correct Ruby version:**
25+
```bash
26+
rbenv install 3.2.2 # If not already installed
27+
rbenv local 3.2.2
28+
```
29+
3. **Install dependencies:**
30+
```bash
31+
# Reason: Use rbenv exec for consistency, avoids potential shell issues
32+
rbenv exec bundle install
33+
```
34+
4. **Create and migrate the database:**
35+
```bash
36+
rbenv exec rails db:create
37+
rbenv exec rails db:migrate
38+
```
39+
40+
## Running the Application
41+
42+
- **Start the development server:**
43+
```bash
44+
rbenv exec bin/dev
45+
```
46+
Visit `http://localhost:3000` in your browser.
47+
48+
## Running Tests
49+
50+
- **Execute the RSpec test suite:**
51+
```bash
52+
rbenv exec bundle exec rspec
53+
```
54+
55+
## Key Design Choices
56+
57+
- **No Frontend Framework:** Uses Hotwire (Turbo/Stimulus) for interactivity.
58+
- **No CSS Framework:** Uses simple, hand-crafted CSS (`app/assets/stylesheets/application.css`).
59+
- **Simple Tagging:** Uses a basic string field for tags to maintain simplicity.
60+
- **No Authentication:** Focuses on core CRUD functionality.

0 commit comments

Comments
 (0)