You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Rewrite README with intro, data notice, and features for open source
visibility. Add CODE_OF_CONDUCT.md (Contributor Covenant) and
CONTRIBUTING.md with development setup and guidelines. Add GitHub
repository link with icon to the site footer.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
We as members, contributors, and leaders pledge to make participation in our community a positive experience for everyone, regardless of background or identity.
6
+
7
+
## Our Standards
8
+
9
+
**Positive behaviors include:**
10
+
11
+
- Using welcoming and inclusive language
12
+
- Being respectful of differing viewpoints and experiences
13
+
- Gracefully accepting constructive criticism
14
+
- Focusing on what is best for the community
15
+
- Showing empathy towards other community members
16
+
17
+
**Unacceptable behaviors include:**
18
+
19
+
- Trolling, insulting or derogatory comments, and personal attacks
20
+
- Public or private harassment
21
+
- Publishing others' private information without explicit permission
22
+
- Other conduct which could reasonably be considered inappropriate in a professional setting
23
+
24
+
## Enforcement
25
+
26
+
Project maintainers are responsible for clarifying and enforcing standards of acceptable behavior. They have the right to remove, edit, or reject contributions that do not align with this Code of Conduct.
27
+
28
+
Instances of unacceptable behavior may be reported by opening an issue on the [GitHub repository](https://github.com/barckcode/tf-mobility) or contacting the project maintainers directly.
29
+
30
+
## Attribution
31
+
32
+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 2.1.
Thank you for your interest in contributing to TF Mobility! This is a citizen transparency project, and community contributions are welcome.
4
+
5
+
Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md) before participating.
6
+
7
+
## How to Contribute
8
+
9
+
1.**Open an issue first** — Before starting work, open a GitHub issue to discuss your proposed change. This helps avoid duplicate effort and ensures alignment with the project direction.
10
+
2.**Fork and branch** — Fork the repository and create a feature branch from `main`.
11
+
3.**Submit a pull request** — Once your changes are ready, open a PR referencing the related issue.
12
+
13
+
## Development Setup
14
+
15
+
### Docker (recommended)
16
+
17
+
The simplest way to run the full stack locally:
18
+
19
+
```bash
20
+
docker-compose up --build
21
+
```
22
+
23
+
This starts the frontend, backend, ETL pipelines, and Nginx reverse proxy. The ETL service will automatically collect and process data into the SQLite database.
24
+
25
+
### Individual Services
26
+
27
+
For working on a specific service, see the [README](README.md#individual-services) for instructions on running each service independently.
28
+
29
+
## Guidelines
30
+
31
+
-**Language**: All code, commits, and documentation must be written in **English**.
32
+
-**ETL pipelines** run inside Docker and use a single SQLite database file. Do not introduce additional databases.
33
+
-**Follow existing conventions** — Match the code style and patterns already present in the codebase.
34
+
-**Write tests** for new functionality and ensure existing tests continue to pass.
35
+
-**Keep PRs focused** — One feature or fix per pull request.
36
+
37
+
## Data Notice
38
+
39
+
The processed data (SQLite database, ETL cache) is not included in the repository. You need to run the ETL pipelines to generate it. See the [README](README.md#getting-started) for details.
40
+
41
+
## Reporting Issues
42
+
43
+
Use [GitHub Issues](https://github.com/barckcode/tf-mobility/issues) to report bugs or suggest features. Please include:
**Citizen Transparency Observatory for Mobility and Infrastructure in Tenerife**
6
+
7
+
---
8
+
9
+
## Introduction
10
+
11
+
TF Mobility is an independent citizen transparency platform that collects, processes, and visualizes public data about mobility and infrastructure in Tenerife, Canary Islands. It aims to make government data accessible and understandable to citizens by aggregating information from official sources into a single, easy-to-navigate dashboard.
12
+
13
+
The platform covers traffic intensity, public transportation analysis, government contract transparency, tourism statistics, and infrastructure projects. All data is sourced from publicly available government datasets and processed through automated ETL pipelines.
14
+
15
+
This is an independent citizen initiative with no political affiliation. Its sole purpose is to promote transparency and informed public discourse about mobility decisions on the island.
16
+
17
+
## Data Notice
18
+
19
+
> **Warning**
20
+
> The processed data (SQLite database and ETL cache files) is **not included** in this repository. To populate the database, you must run the ETL pipelines. See the [Getting Started](#getting-started) section for instructions.
21
+
22
+
## Features
23
+
24
+
-**Traffic Intensity** — Interactive maps and charts showing real-time and historical traffic data across Tenerife
25
+
-**Public Transit Analysis** — Comprehensive study of bus (TITSA), tram (Tranvía), taxi, and VTC services
26
+
-**Contract Transparency** — Government contracts database with company details, award amounts, and related entities
27
+
-**Tourism Statistics** — Visitor data and its relationship to mobility infrastructure
28
+
-**Government Promises Tracker** — Monitoring of official commitments related to mobility projects
├── etl/ # Python ETL pipelines for data collection
47
+
├── nginx/ # Nginx reverse proxy configuration
48
+
├── ssl/ # SSL certificate configuration
13
49
└── docker-compose.yml
14
50
```
15
51
16
-
## Development
52
+
## Getting Started
53
+
54
+
### Docker (recommended)
55
+
56
+
The easiest way to run the full stack:
17
57
18
-
### Frontend
58
+
```bash
59
+
docker-compose up --build
60
+
```
61
+
62
+
This starts the frontend, backend, ETL pipelines, and Nginx reverse proxy. The ETL service will automatically begin collecting and processing data into the SQLite database.
63
+
64
+
### Individual Services
65
+
66
+
For development, you can run each service independently:
Contributions are welcome! Please read our [Contributing Guide](CONTRIBUTING.md) and [Code of Conduct](CODE_OF_CONDUCT.md) before submitting a pull request.
0 commit comments