KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#developer-tools #typescript #dsh #dsh-plugin #ai-agent #codex #ai-agents #deepseek-harness #claude-code #cli #react #mcp

vimgolf_on_rails

★ 68 Open GitHub ↗

A web-based Vim practice platform built with Rails 8. To improve your Vim motions in a gamified way.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# VimGolf on Rails

A web-based Vim practice application where users can solve editing challenges and improve their Vim skills through interactive exercises and practice sessions.
    
        
          
          
## Technologies

- **Ruby on Rails** 8.0.3
- **Stimulus JS** - Frontend interactivity
- **Turbo Rails** - SPA-like experience
- **Tailwind CSS** - Styling
- **SQLite** - Database
- **Devise** - User authentication
- **Pagy** - Pagination
- **Importmap** - JavaScript management

## Features

- **User Authentication** - Sign up, login, and manage your account
- **Vim Exercises** - Browse and practice various Vim editing challenges
- **Play Mode** - Solve individual exercises with an integrated code editor
- **Practice Sessions** - Complete multiple exercises in sequence with the ability to skip challenges
- **Star Hunt Training** - Practice navigation and precision by finding and deleting stars in progressively challenging stages
- **Copy/Paste Protection** - Anti-cheating measures to ensure authentic Vim practice
- **Progress Tracking** - Track your attempts and view detailed statistics
- **Responsive Design** - Modern gaming-themed UI with neon accents built with Tailwind CSS

## The Process

This project was built as a learning exercise to create a VimGolf-style practice platform using Ruby on Rails. The development focused on:

1. Setting up a Rails 8 application with modern frontend tooling
2. Integrating an interactive code editor within the Rails ecosystem
3. Implementing exercise management and user progress tracking
4. Creating an intuitive UI for practicing Vim commands
5. Building practice session workflows with statistics
6. Developing multiple game modes including Star Hunt Training for focused skill development
7. Implementing copy/paste protection to ensure authentic practice

## What I Learned

- **Better Vim Usage** - Deepened understanding of Vim commands and editing patterns while creating the exercises
- **Stimulus Integration** - Learned how to effectively integrate Stimulus controllers with complex interactive components like code editors inside a Ruby on Rails application
- **Modern Rails** - Gained experience with Rails 8's updated frontend approach using Importmap and Stimulus
- **Procedural Content Generation** - Implemented dynamic stage generation for Star Hunt Training mode
- **Client-Side Security** - Developed copy/paste protection mechanisms to maintain practice integrity
- **UI/UX Design** - Created an engaging gaming-themed interface with modern visual effects

## What Could Be Improved

- Add more exercises and difficulty levels for both modes
- Implement a leaderboard system to compare scores across users
- Add exercise categories and filtering options
- Include video tutorials or hints for difficult exercises
- Export/import exercise data for sharing
- Add social features like sharing solutions and community challenges
- Implement real Vim key bindings validation
- Expand Star Hunt Training with more stage types and difficulty progression
- Add achievements and badges for milestones
- Implement multiplayer or competitive modes

## How to Run the Project

### Prerequisites

- Ruby 3.x
- Rails 8.0.3
- SQLite3

### Setup

1. Clone the repository:
   ```bash
   git clone <repository-url>
   cd vimgolf_on_rails
   ```

2. Install dependencies:
   ```bash
   bundle install
   ```

3. Setup the database:
   ```bash
   rails db:create
   rails db:migrate
   rails db:seed
   ```

4. Start the development server:
   ```bash
   rails server
   ```

5. Visit `http://localhost:3000` in your browser

### Running Tests

```bash
rails test
```

## Video

https://github.com/user-attachments/assets/17b62bc6-f256-4995-bb18-cc3a08854b64

## License

This project is open source and available under the MIT License.

vimgolf_on_rails

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README