https://github.com/hwesselmann/ranking-info
A small web-app to help browse and analyze the German Tennis youth rankings.
https://github.com/hwesselmann/ranking-info
rails ruby tennis
Last synced: 2 months ago
JSON representation
A small web-app to help browse and analyze the German Tennis youth rankings.
- Host: GitHub
- URL: https://github.com/hwesselmann/ranking-info
- Owner: hwesselmann
- License: apache-2.0
- Created: 2020-04-05T07:58:58.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2026-01-09T09:56:43.000Z (6 months ago)
- Last Synced: 2026-01-12T16:56:37.811Z (6 months ago)
- Topics: rails, ruby, tennis
- Language: Ruby
- Homepage: https://www.ranking-info.net
- Size: 1.6 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ranking-info
This is a small web-application aiming at providing accessible information on the German national tennis youth rankings.
## Prerequisites
This application is developed using
* Ruby 4.0.3
* Rails 8.1.3
* Node.js 22 (for asset compilation)
* SQLite3 (for development and test)
* PostgreSQL (for production)
* Bundler (Ruby gem management)
* Yarn (JavaScript package management)
## Setup
To set up a development environment, run the following steps before starting the server:
```bash
# Install Ruby gems
bundle install
# Install JavaScript packages (also copies FontAwesome webfonts)
yarn install
# Run database migrations
bin/rails db:migrate
# Build JavaScript and CSS assets
yarn build
yarn build:css
```
Then start the development server:
```bash
bin/rails server
```
To automatically rebuild assets on changes, run the following in separate terminals alongside the server:
```bash
yarn build --watch
yarn build:css --watch
```
## Tests
To run the test suite:
```bash
bin/rails test
```
The project also includes Guard for running tests automatically on code changes. Start it from the project folder with:
```bash
guard
```
## Import file format
To import data into the system, create a CSV file from the official ranking list PDF using a tool like Tabula. The file must be in the format:
> ranking-position, lastname, firstname, nationality, dtb_id, federation, club, score
This is the default column order Tabula produces. An example file can be found in `test/fixtures/files`.
## Importing data / login credentials
Access to the CSV upload functionality is restricted to registered users. To create an admin user:
1. Ensure the database is up to date: `bin/rails db:migrate`
2. Open a Rails console: `bin/rails console`
3. Create a user:
```ruby
User.create(name: 'Example User', email: 'user@example.com', password: 'password', password_confirmation: 'password')
```
The password must be at least 6 characters.
## Deploy
### Docker
The project includes a Dockerfile and a docker-compose configuration for a production environment. Adapt `docker-compose.yml` to your needs, build the image, then start the stack:
```bash
DATABASE_PASSWORD=your_password docker-compose up
```
After the stack is running, run database migrations and create an admin user (see above).
The application is then available at `http://127.0.0.1:3000`.
### Standalone
Set the following environment variables to populate the imprint on the about page (or hardcode them in `config/config.yml`):
| Variable | Description |
|---|---|
| `DOMAIN` | Domain the application is deployed to |
| `IMPRINT_NAME` | Name for the imprint |
| `IMPRINT_STREET` | Street and street number for the imprint |
| `IMPRINT_ZIPCODE` | Zip code for the imprint |
| `IMPRINT_CITY` | City for the imprint |
| `IMPRINT_PHONE` | Phone number for the imprint |
| `IMPRINT_MAIL` | Email address for the imprint |