Initial project setup with README and .gitignore
This commit is contained in:
54
README.md
Normal file
54
README.md
Normal file
@@ -0,0 +1,54 @@
|
||||
# TapTrack — Marketing Website
|
||||
|
||||
Official marketing and product website for **TapTrack**, a smart NFC-based student attendance management system built for Philippine schools.
|
||||
|
||||
## About TapTrack
|
||||
|
||||
TapTrack automates student attendance tracking with:
|
||||
- NFC tap-in for instant, paperless attendance
|
||||
- Real-time SMS alerts to parents
|
||||
- Cloud-based dashboards for administrators and principals
|
||||
- Automated monthly billing and reports
|
||||
|
||||
## Project Structure
|
||||
|
||||
```
|
||||
TapTrack Website/
|
||||
├── src/
|
||||
│ ├── components/ # Reusable UI components
|
||||
│ ├── pages/ # Page components
|
||||
│ ├── assets/ # Images, icons, fonts
|
||||
│ └── styles/ # Global styles & Tailwind config
|
||||
├── public/ # Static assets
|
||||
└── index.html
|
||||
```
|
||||
|
||||
## Tech Stack (Planned)
|
||||
|
||||
- **Framework**: Vue 3 + TypeScript
|
||||
- **Styling**: Tailwind CSS v4
|
||||
- **Build**: Vite
|
||||
- **Deployment**: Vercel / Netlify
|
||||
|
||||
## Design
|
||||
|
||||
Mock design created in Pencil. Pending approval before development begins.
|
||||
|
||||
### Pages
|
||||
- `/` — Landing page (hero, features, pricing, testimonials)
|
||||
- `/features` — Full features breakdown
|
||||
- `/pricing` — Detailed pricing & comparison
|
||||
- `/about` — Company story
|
||||
- `/contact` — Contact & demo request form
|
||||
- `/blog` — News & updates
|
||||
|
||||
## Getting Started
|
||||
|
||||
```bash
|
||||
npm install
|
||||
npm run dev
|
||||
```
|
||||
|
||||
## Status
|
||||
|
||||
> Design phase — awaiting approval before development begins.
|
||||
Reference in New Issue
Block a user