This is a Flutter front-end notes app that allows users to create, modify, and delete notes. It uses Firebase for authentication and MongoDB as the database, with a Node.js backend. This README will guide you through the setup and running of the application.
You can try out the live demo of Notes App at: https://example.com/notes-app
|
|
|
|
|
Before you begin, ensure you have the following installed on your system:
- Flutter SDK: Installation Guide
- Node.js: Installation Guide
- MongoDB: Installation Guide
- Firebase Project: Firebase Console
-
Clone the repository to your local machine:
git clone https://github.com/yourusername/flutter-notes-app.git
-
Change to the project directory:
cd flutter-notes-app
-
Install Flutter dependencies:
flutter pub get
-
Install Node.js server dependencies:
cd server npm install
-
Configure Firebase:
-
Create a Firebase project in the Firebase Console.
-
Go to Project Settings and add a new web app to get the Firebase configuration keys.
-
Copy the Firebase configuration object from the Firebase Console and replace it in
lib/services/firebase_service.dart
in the Flutter app:const firebaseConfig = { apiKey: "YOUR_API_KEY", authDomain: "YOUR_AUTH_DOMAIN", projectId: "YOUR_PROJECT_ID", storageBucket: "YOUR_STORAGE_BUCKET", messagingSenderId: "YOUR_MESSAGING_SENDER_ID", appId: "YOUR_APP_ID", };
-
-
Configure MongoDB:
- Start your MongoDB server.
- Create a new MongoDB database and collection for this app.
-
Configure Node.js server:
- Rename the
config.example.js
file in theserver
directory toconfig.js
. - Update the MongoDB connection URI in
config.js
to point to your MongoDB database.
- Rename the
-
Start the Node.js server:
cd server node server.js
-
Run the Flutter app:
flutter run
-
Register or log in using Firebase authentication.
-
Add, modify, or delete notes as needed through the Flutter app.
Feel free to contribute to this project by opening issues or submitting pull requests. Please follow the code of conduct and contribution guidelines.
This project is licensed under the MIT License - see the LICENSE file for details.
- Thanks to the Flutter, Node.js, Firebase, and MongoDB communities for their excellent documentation and support.
Happy note-taking with your Flutter Notes App! If you have any questions or encounter any issues, please don't hesitate to reach out for assistance.