https://github.com/maybethee/gawlf
The classic playing card game adapted to be playable with friends across vast distances from the comfort of your own browser
https://github.com/maybethee/gawlf
card-game game multiplayer-browser-game react ruby-on-rails
Last synced: about 1 month ago
JSON representation
The classic playing card game adapted to be playable with friends across vast distances from the comfort of your own browser
- Host: GitHub
- URL: https://github.com/maybethee/gawlf
- Owner: maybethee
- License: other
- Created: 2024-10-27T18:22:36.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-03-30T21:05:07.000Z (about 2 months ago)
- Last Synced: 2025-04-11T04:39:39.419Z (about 1 month ago)
- Topics: card-game, game, multiplayer-browser-game, react, ruby-on-rails
- Language: JavaScript
- Homepage: https://gawlf.fly.dev
- Size: 105 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Gawlf
A turn-based multiplayer game to play online with friends, based on the classic playing card game Golf.
## Play the Game
🎮 Visit the live site and create a lobby to play with at least one friend: [Gawlf](https://gawlf.fly.dev)
## Features
- Play with 2 to 8 players in real-time.
- Selection of backgrounds and card-back designs to customize experience.
- Profiles that display past game records and unique player stats.
- Supports desktop and mobile browsers.
## Technologies
- Frontend: React, Vite
- Backend: Rails
- Deployment: Fly.io
## For Developers
If you'd like to explore or contribute to the codebase, you can set up the project locally by following these steps:
### Prerequisites
Make sure you have the following installed:
- **Ruby** (with Bundler)
- **Node.js** and **npm**
- **PostgreSQL** (or the database you're using)
- **Rails**
---
### Getting Started
1. **Clone the repository:**
```
git clone https://github.com/maybethee/gawlf.git
cd gawlf
```
3. **Set up the backend:**
- Install ruby gems:
```
bundle install
```
- Set up the database:
```
rails db:create db:migrate
```
- Start the Rails server:
```
rails s
```
- By default, the backend will run on `http://localhost:3000`
3. **Set up the frontend:**
- Navigate to the React app folder inside the rails app:
```
cd gawlf-fe
```
- Install npm dependencies:
```
npm install
```
- Start the development server:
```
npm run dev
```
- By default, the frontend will run on `http:/localhost:5173`
4. **Access the app**: Open your browser and navigate to `localhost:5173`. The frontend will communicate with the backend on `http://localhost:3000`.
### Notes
- **Hot Reloading**: Changes in the React app will be reflected in real time, but backend changes will require you to restart the Rails server.
---
## Contributing
Feel free to open an issue or submit a pull request if you encounter any problems or have ideas for improvements!
## License
This project is licensed under the [Creative Commons Attribution-NonCommercial 4.0 International License](LICENSE).