Welcome to Notezy, a simple and intuitive web-based note-taking platform built with Node.js, Express, MongoDB, and EJS templating. The app allows users to sign up, log in, create, view, search, and delete notes — all with a clean UI and user-friendly dashboard.
🚀 Proudly selected for SSoC'25
📌 Maintained by Soumya Srivastav (Project Admin)
💡 Want to try it live? Deploying soon on Vercel/Render – Stay tuned!
- 👤 User Authentication (Register/Login with secure sessions)
- ✏️ Create, Edit & Delete Notes
- 🔍 Search Notes by title/content
- 🧾 Clean & Responsive UI with EJS Templates
- 🧠 MVC Architecture with Controllers, Routes, and Middleware
- 📁 Well-structured codebase for scalability
- ✅ Protected routes using middleware (
checkAuth.js) - ⚙️ MongoDB integration with Mongoose schemas
| Tech | Description |
|---|---|
| Node.js | JavaScript runtime |
| Express.js | Web framework |
| MongoDB | NoSQL Database |
| Mongoose | ODM for MongoDB |
| EJS | Embedded JavaScript |
| Bootstrap | Frontend Styling |
| express-session | Session management |
Notezy/
├── app.js
├── package.json
├── .env
├── public/
│ ├── css/
│ │ └── main.css
│ └── img/
├── server/
│ ├── controllers/
│ │ ├── mainController.js
│ │ └── dashboardController.js
│ ├── middleware/
│ │ └── checkAuth.js
│ ├── models/
│ │ ├── User.js
│ │ └── Notes.js
│ └── routes/
│ ├── auth.js
│ ├── dashboard.js
│ └── index.js
├── views/
│ ├── index.ejs
│ ├── about.ejs
│ ├── 404.ejs
│ ├── layouts/
│ │ ├── front-page.ejs
│ │ ├── main.ejs
│ │ └── dashboard.ejs
│ ├── partials/
│ │ ├── header.ejs
│ │ ├── footer.ejs
│ │ └── header_dashboard.ejs
│ └── dashboard/
│ ├── add.ejs
│ ├── index.ejs
│ ├── search.ejs
│ └── view-notes.ejs
- Clone the repository
git clone https://github.com/soumya813/Notes-App.git
cd Notes-App- Install Dependencies
npm install- Set Up Environment Variables
Refer to CONTRIBUTING.md to find out how to get the keys.
Create a .env file in the root directory and add:
MONGODB_URI=your_mongodb_connection_string
GOOGLE_CLIENT_ID=your_google_client_id
GOOGLE_CLIENT_SECRET=your_google_client_secret
GOOGLE_CALLBACK_URL=http://localhost:5000/google/callback
PORT=5000- Run the App
npm startThe app will run at http://localhost:5000
Set these environment variables in your hosting provider:
# Database (Required)
MONGODB_URI=mongodb+srv://username:password@cluster.mongodb.net/notes-app
# Google OAuth (Required)
GOOGLE_CLIENT_ID=your_google_client_id
GOOGLE_CLIENT_SECRET=your_google_client_secret
GOOGLE_CALLBACK_URL=https://yourdomain.com/google/callback
# Security (Required for production)
SESSION_SECRET=your_super_secret_random_string_here
NODE_ENV=production
PORT=5000
# Optional Features
HUGGING_FACE_API=your_hugging_face_token
REDIS_URL=redis://localhost:6379
DOMAIN=yourdomain.com
# Email (Optional)
SMTP_HOST=smtp.gmail.com
SMTP_PORT=587
SMTP_USER=your_email@gmail.com
SMTP_PASS=your_app_password
SMTP_FROM=noreply@yourdomain.com- Install Heroku CLI
- Login and create app:
heroku login
heroku create your-notes-app- Set environment variables:
heroku config:set NODE_ENV=production
heroku config:set MONGODB_URI=your_mongodb_uri
heroku config:set SESSION_SECRET=your_secret
# ... add all other required vars- Deploy:
git add .
git commit -m "Deploy to production"
git push heroku main- Build image:
docker build -t notes-app .- Run container:
docker run -d \
-p 5000:5000 \
-e NODE_ENV=production \
-e MONGODB_URI=your_mongodb_uri \
-e SESSION_SECRET=your_secret \
--name notes-app \
notes-app- Connect your GitHub repository
- Set environment variables in the dashboard
- Use build command:
npm install - Use start command:
npm start
This app includes collaborative editing powered by Socket.IO:
- Live updates while multiple authenticated users view the same note
- Presence and typing indicators
- Changes sync instantly; saving persists the note
It runs over the same Express server and reuses session authentication. No extra setup is required for local development.
📢 This project is officially part of SSoC'25 (Social Summer of Code 2025)!
We ❤️ contributions!
- Fork the repo
- Create a new branch:
git checkout -b feature-name - Make your changes and commit
- Push and submit a PR
- Wait for review 🙌
Please follow our Code of Conduct and Contributing Guidelines (coming soon).
| Name | GitHub | Role |
|---|---|---|
| Soumya Srivastav | @soumya813 | Project Admin |
This project is licensed under the MIT License. See LICENSE for details.