Skip to content

README.md

Latest commit

 

History

History
165 lines (125 loc) · 4.22 KB

README.md

File metadata and controls

165 lines (125 loc) · 4.22 KB

Notore

Notore is a full-stack notes management app that allows users to securely create, edit, and organize notes across devices.
It was built with a Kotlin (Android) frontend and a Node.js + MongoDB backend. this is my first fullstack app whose backend is available in this repo 👉 https://github.com/Gopal0Gupta/Notore-NotesAPI The app was previously published on the Google Play Store.

📱 App Preview

Watch the Demo

🧠 Your Thoughts, Organized – Anytime, Anywhere with Notore

🚀 Features

  • ✍️ Create, edit, and delete notes with ease
  • ☁️ Cloud synchronization using custom backend
  • 🔒 User authentication and secure data storage
  • 📱 Clean and minimal UI using Kotlin
  • 📤 Data persistence using MongoDB Atlas
  • ⚙️ API integration via Retrofit

🧩 Tech Stack

🧾 Notes Management

  • Create, edit, and delete notes effortlessly.
  • Auto-save feature ensures no data loss.
  • Organized list view with timestamps.
  • Offline-first experience with local caching.

🔐 Authentication

  • Secure signup/login using email & password.
  • JWT-based authentication via Node.js backend.
  • Encrypted credentials and protected APIs.

☁️ Cloud Sync

  • Real-time sync between devices using MongoDB.
  • Fetches user-specific notes on login.
  • Instant updates when notes are modified.

🧰 Smart UI

  • Built with modern Jetpack Compose
  • Elegant and responsive note editor
  • Smooth animations and dark mode support

🛠️ Tech Stack

Category Tech Used
Language Kotlin
UI Framework Jetpack Compose
Backend Node.js + Express.js
Database MongoDB (Mongoose ORM)
Authentication JWT (JSON Web Token)
Networking Retrofit + Coroutines
Hosting (optional) Render / Vercel / Heroku
Version Control Git, GitHub

📂 Project Structure (Simplified)

/notore-app
├── android/
│   ├── screens/
│   │   ├── NotesList/
│   │   ├── AddEditNote/
│   │   └── Auth/
│   ├── viewmodels/
│   ├── data/
│   │   ├── models/
│   │   ├── network/
│   │   └── repository/
│   └── utils/
│
├── server/
│   ├── models/
│   ├── routes/
│   ├── controllers/
│   ├── middlewares/
│   └── server.js

📲 Installation

  1. Clone the repository 
    git clone https://github.com/Gopal0Gupta/Notore.git
  2. Navigate to the backend folder 
    cd Notore/server
  3. Install dependencies 
    npm install
  4. Set up environment variables 
    PORT=5000
MONGO_URI=your_mongo_connection_string
JWT_SECRET=your_secret_key
  5. Start the server 
    npm start
  6. Open the Android project
    • Navigate to /android folder in Android Studio
    • Update base URL in Retrofit client (e.g., http://<your-ip>:5000)
    • Sync Gradle and run the app on emulator or device (API 26+ recommended)

🛡 Badges

Kotlin Node.js MongoDB JWT

💡 Future Enhancements

  • AI-powered smart note suggestions
  • Real-time sync via WebSockets
  • Markdown note editor
  • Offline mode support
  • Cloud backup & restore
  • Notification reminders for notes
  • Google Sign-In integration
  • Dark mode improvements

🤝 Contributing

Pull requests, issues, and suggestions are welcome.
For major changes, please open an issue to discuss proposed changes.

👨‍💻 Developer

Gopal Gupta
📧 gopalgupta072004@gmail.com
🔗 LinkedIn | GitHub