Skip to content

Commit eaf2276

Browse files
authored
add quicknote readme
1 parent 28adb8a commit eaf2276

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# QuickNotes
2+
3+
A real-time note-taking web app using Firebase Firestore for seamless cloud synchronization.
4+
5+
## Overview
6+
7+
QuickNotes is a modern, responsive web application that allows users to create, edit, and organize notes in real-time. Built with Firebase Firestore as the backend, all changes are instantly synchronized across devices, ensuring you never lose your important notes.
8+
9+
## Features
10+
11+
- 📝 **Real-Time Sync** - Changes are instantly reflected across all devices using Firebase Firestore
12+
- 🔐 **Cloud Storage** - All notes are securely stored in the cloud
13+
- 📱 **Responsive Design** - Works seamlessly on desktop, tablet, and mobile devices
14+
-**Intuitive UI** - Clean and user-friendly interface for effortless note-taking
15+
- 🚀 **Fast Performance** - Optimized for quick load times and smooth interactions
16+
17+
## Tech Stack
18+
19+
- **Frontend**: JavaScript (51.1%), HTML (24.1%), CSS (24.8%)
20+
- **Backend**: Firebase Firestore
21+
- **Architecture**: Web-based application
22+
23+
## Getting Started
24+
25+
### Prerequisites
26+
27+
- Node.js and npm installed on your system
28+
- A Firebase project with Firestore enabled
29+
- Firebase credentials configured
30+
31+
### Installation
32+
33+
1. Clone the repository:
34+
```bash
35+
git clone https://github.com/khalid-ameri/QuickNotes.git
36+
cd QuickNotes

0 commit comments

Comments
 (0)