Skip to content

Commit 7e7335b

Browse files
committed
fix: update README for clarity and formatting improvements
1 parent e5b1974 commit 7e7335b

1 file changed

Lines changed: 56 additions & 43 deletions

File tree

README.md

Lines changed: 56 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,79 @@
1-
# HackerTracker Web
1+
# Hacker Tracker Web
22

3-
HackerTracker Web is the web-based interface for the HackerTracker mobile applications. For mobile versions, check out the [Android](https://github.com/junctor/android) and [iOS](https://github.com/junctor/hackertracker) repositories.
3+
[![Vite](https://img.shields.io/badge/Bundler-Vite_7-646CFF?logo=vite&logoColor=white)](https://vitejs.dev)
4+
[![React](https://img.shields.io/badge/Framework-React_19-61DAFB?logo=react&logoColor=white)](https://react.dev)
5+
[![TailwindCSS](https://img.shields.io/badge/Styling-Tailwind_4-38B2AC?logo=tailwind-css&logoColor=white)](https://tailwindcss.com)
6+
[![TypeScript](https://img.shields.io/badge/Language-TypeScript_5-3178C6?logo=typescript&logoColor=white)](https://www.typescriptlang.org)
7+
[![Firebase](https://img.shields.io/badge/Data-Firebase_12-FFCA28?logo=firebase&logoColor=white)](https://firebase.google.com)
8+
[![License](https://img.shields.io/badge/License-MIT-lightgrey)](../../LICENSE)
49

5-
## Getting Started
10+
<h1 align="center">
11+
<a href="https://hackertracker.app">
12+
<img src="https://github.com/junctor/android/blob/main/app/src/main/play_store_512.png" alt="Hacker Tracker Logo" width="150">
13+
</a>
14+
<br>
15+
Hacker Tracker Web
16+
<br>
17+
</h1>
618

7-
### Prerequisites
19+
<h3 align="center">Every schedule. Every event. Every party.<br>Help your conference attendees help themselves.</h3>
820

9-
Ensure you have the following installed:
21+
---
1022

11-
- [Node.js](https://nodejs.org) (version 18 or later recommended)
12-
- [npm](https://www.npmjs.com/) (version 8 or later)
23+
## 🌐 What is Hacker Tracker Web?
1324

14-
### Installation
25+
Hacker Tracker Web is the **browser-based companion** to the [Hacker Tracker Android](https://github.com/junctor/android) and [iOS](https://github.com/junctor/hackertracker-ios) apps.
26+
It brings **real-time conference schedules, maps, and event details** directly to your browser.
1527

16-
Install the necessary dependencies:
28+
Trusted by legendary hacker and security conferences worldwide:
1729

18-
```bash
19-
npm install
20-
```
30+
- **DEF CON**
31+
- **BSides** (many chapters)
32+
- **SaintCon**
33+
- **Ekoparty**
34+
- **CactusCon**
35+
- **NolaCon**
36+
- **VCF Midwest**
37+
- and more…
2138

22-
### Running the Development Server
39+
---
2340

24-
Start the development server with:
41+
## 🛠️ Built With
2542

26-
```bash
27-
npm run dev
28-
```
43+
Hacker Tracker Web runs on a **modern, fast, type-safe stack**:
2944

30-
By default, Vite serves the app at `http://localhost:5173`.
45+
- **Vite 7** – blazing-fast dev server & bundler
46+
- **React 19 + React Router 7** – powerful, component-driven UI & routing
47+
- **Tailwind CSS 4 + Headless UI + Heroicons** – accessible, utility-first design
48+
- **Firebase 12** – real-time data and hosting infrastructure
49+
- **TypeScript 5** – strict typing for reliability and maintainability
50+
- **ESLint + Prettier** – consistent code quality and formatting
3151

32-
### Building for Production
52+
---
3353

34-
To create an optimized production build:
54+
## 🤝 For Conferences & Organizers
3555

36-
```bash
37-
npm run build
38-
```
56+
Hacker Tracker helps your attendees get the most out of your event:
3957

40-
Preview the build locally with:
58+
- **No cost** for most events (large conferences may cover operational costs)
59+
- **Privacy-first**: no ads, no user tracking, no data collection
60+
- **Sponsor recognition** for in-kind support
61+
- **Integrations supported**: Pretalx, Sessionize, Sched
62+
- **Flexible data import** via spreadsheets or text files
4163

42-
```bash
43-
npm run preview
44-
```
64+
➡️ Interested? Reach out to [aNullValue](https://defcon.social/@aNullValue) to get started.
4565

46-
The static assets will be generated in the `dist` directory. These can be deployed directly to GitHub Pages or any static host.
66+
---
4767

48-
### Usage
68+
## 👥 The Team
4969

50-
After setting up the development environment, open the app at `http://localhost:5173` (or your configured dev server URL). Use the navigation menu to explore conferences, schedules, events, and more.
70+
Hacker Tracker is maintained by a small group of volunteers:
5171

52-
## Technologies Used
72+
- [Advice-Dog](https://github.com/Advice-Dog) – Android lead
73+
- [aNullValue](https://github.com/aNullValue) – project lead & ConfMgr
74+
- [cak](https://github.com/cak) – Web lead
75+
- [sethlaw](https://github.com/sethlaw) – iOS lead
5376

54-
- **Bundler / Dev Server**: [Vite](https://vitejs.dev)
55-
- **Routing**: [React Router](https://reactrouter.com)
56-
- **Styling**: [Tailwind CSS](https://tailwindcss.com), [Headless UI](https://headlessui.dev)
57-
- **Language**: [TypeScript](https://www.typescriptlang.org)
77+
---
5878

59-
## Contributors
60-
61-
Meet the HackerTracker Team:
62-
63-
- [Advice-Dog](https://github.com/Advice-Dog)
64-
- [aNullValue](https://github.com/aNullValue)
65-
- [cak](https://github.com/cak)
66-
- [sethlaw](https://github.com/sethlaw)
79+
<p align="center">💀 Hacker Tracker: by hackers, for hackers. 💀</p>

0 commit comments

Comments
 (0)