https://github.com/sxryxnshs5/lekh-note_app
Lekh is a simple and user-friendly note-taking app built with Flutter and Firebase. It allows users to create, save, and view their notes seamlessly. The app ensures that each user's notes are securely stored and accessible only to them.
https://github.com/sxryxnshs5/lekh-note_app
firebase flutter note-taking-app
Last synced: 2 months ago
JSON representation
Lekh is a simple and user-friendly note-taking app built with Flutter and Firebase. It allows users to create, save, and view their notes seamlessly. The app ensures that each user's notes are securely stored and accessible only to them.
- Host: GitHub
- URL: https://github.com/sxryxnshs5/lekh-note_app
- Owner: SxryxnshS5
- Created: 2024-06-25T14:12:31.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-03T13:30:31.000Z (almost 2 years ago)
- Last Synced: 2024-12-28T04:51:01.194Z (over 1 year ago)
- Topics: firebase, flutter, note-taking-app
- Language: C++
- Homepage:
- Size: 321 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
### README for Lekh
# Lekh
Lekh is a simple and user-friendly note-taking app built with Flutter and Firebase. It allows users to create, save, and view their notes seamlessly. The app ensures that each user's notes are securely stored and accessible only to them.
## Features
- User Authentication with Firebase
- Register new users
- Login for existing users
- Email verification
- Note Management
- Create new notes
- View a list of saved notes
- Expand and collapse long notes
- Scrollable interface to manage multiple notes
- Secure and efficient storage with Firebase Firestore
## Screenshots
https://drive.google.com/drive/folders/1MWe2hdwjBw9gZqZ5oD8uZ3KxwrG-_O1r?usp=sharing
## Installation
### Prerequisites
- Flutter SDK: [Install Flutter](https://flutter.dev/docs/get-started/install)
- Firebase Account: [Create Firebase Project](https://firebase.google.com/)
### Setup
1. **Clone the repository:**
```sh
git clone https://github.com/your_username/lekh.git
cd lekh
```
2. **Install dependencies:**
```sh
flutter pub get
```
3. **Firebase Setup:**
- Follow the instructions to add Firebase to your Flutter app: [Add Firebase to your Flutter app](https://firebase.google.com/docs/flutter/setup)
- Replace the contents of `lib/firebase_options.dart` with your Firebase project configuration.
4. **Run the app:**
```sh
flutter run
```
## Usage
1. **Register:**
- Open the app and register a new account using your email and password.
- Verify your email through the link sent to your email address.
2. **Login:**
- Log in using your registered email and password.
3. **Create a Note:**
- Enter your note in the text field provided and click "Add Note".
4. **View Notes:**
- Scroll through your notes. Click on a note to expand or collapse it.
5. **Logout:**
- Click on the logout icon in the top right corner of the app to sign out.
## Contributing
Contributions are welcome! Please open an issue or submit a pull request for any improvements or bug fixes.
1. Fork the repository.
2. Create a new branch: `git checkout -b feature-branch`
3. Make your changes and commit them: `git commit -m 'Add some feature'`
4. Push to the branch: `git push origin feature-branch`
5. Open a pull request.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
## Contact
If you have any questions or feedback, please feel free to reach out:
- Email: suryansh.cloud@gmail.com
- GitHub: [SxryxnshS5](https://github.com/SxryxnshS5)
---
Thank you for using Lekh! Happy note-taking!