TeamIDE-methodology/templates/README.md

74 lines
1.3 KiB
Markdown

# Project Name
> One-line tagline describing what this project does
![Hero Screenshot](https://raw.githubusercontent.com/dcherrera/ProjectName/main/screenshots/hero.png)
## Overview
Brief description of what the project does and the problem it solves. Keep this to 2-3 paragraphs max.
Explain the motivation - why does this exist? What pain point does it address?
## Features
- **Feature 1** - Brief description
- **Feature 2** - Brief description
- **Feature 3** - Brief description
## Screenshots
![Feature Demo](https://raw.githubusercontent.com/dcherrera/ProjectName/main/screenshots/demo.gif)
![Feature Name](https://raw.githubusercontent.com/dcherrera/ProjectName/main/screenshots/feature-name.png)
## Tech Stack
- **Frontend**: Vue 3, TypeScript, Quasar
- **Backend**: Nhost (PostgreSQL, Hasura, Auth)
- **Desktop**: Tauri (if applicable)
## Getting Started
### Prerequisites
- Node.js 18+
- npm or yarn
### Installation
```bash
git clone https://github.com/dcherrera/ProjectName.git
cd ProjectName/app
npm install
```
### Usage
```bash
npm run dev
```
## Development
```bash
# Run development server
npm run dev
# Build for production
npm run build
# Run tests
npm test
```
## Status
**Active** - Currently in development
<!-- Status options: Active | Maintained | Paused | Archived | Concept -->
## License
[MIT Transparency License](LICENSE)