{"id":26047633,"url":"https://github.com/tejas-130704/docs","last_synced_at":"2025-03-07T23:12:29.382Z","repository":{"id":279760168,"uuid":"939858735","full_name":"tejas-130704/docs","owner":"tejas-130704","description":"Welcome to the Notes App, a feature-rich full-stack application designed to help users create, edit, delete, and manage notes effortlessly! With a smooth and interactive UI, this app ensures a seamless user experience.","archived":false,"fork":false,"pushed_at":"2025-02-27T08:59:35.000Z","size":75,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-27T12:12:08.375Z","etag":null,"topics":["curd","docker","docker-compose","docs","expressjs","nodejs","notes","react-vite"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tejas-130704.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-02-27T08:17:57.000Z","updated_at":"2025-02-27T09:02:34.000Z","dependencies_parsed_at":"2025-02-27T12:13:28.603Z","dependency_job_id":null,"html_url":"https://github.com/tejas-130704/docs","commit_stats":null,"previous_names":["tejas-130704/docs"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tejas-130704%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tejas-130704%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tejas-130704%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tejas-130704%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tejas-130704","download_url":"https://codeload.github.com/tejas-130704/docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242473055,"owners_count":20134020,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["curd","docker","docker-compose","docs","expressjs","nodejs","notes","react-vite"],"created_at":"2025-03-07T23:12:28.829Z","updated_at":"2025-03-07T23:12:29.377Z","avatar_url":"https://github.com/tejas-130704.png","language":"JavaScript","readme":"# 📝Docs - Notes App\n\n## 🚀 Overview\nWelcome to the **Notes App**, a feature-rich full-stack application designed to help users create, edit, delete, and manage notes effortlessly! With a smooth and interactive UI, this app ensures a seamless user experience.\n\n🔹 **Frontend:** Built with **React + Vite** for lightning-fast performance and a dynamic UI.  \n🔹 **Backend:** Powered by **Express.js** and **MongoDB**, ensuring robust and scalable data management.  \n🔹 **Deployment:** Easily containerized using **Docker**, making it super easy to set up and run anywhere.  \n\n## 🌟 Features\n✅ **Create Notes** – Add new notes in seconds.  \n✅ **Edit Notes** – Modify your existing notes anytime.  \n✅ **Delete Notes** – Remove notes when they are no longer needed.  \n✅ **View Notes** – Display and organize notes with an interactive layout.  \n✅ **User-Friendly UI** – Experience smooth animations and seamless interactions.  \n✅ **Mobile Responsive** – Works perfectly across devices.  \n✅ **Persistent Storage** – Notes are stored in MongoDB for future access.  \n✅ **Dockerized Setup** – Hassle-free setup with `docker-compose`.  \n\n## 🏗️ Tech Stack\n### 📌 Frontend\n- **React.js** – Fast and component-driven UI framework.  \n- **Vite.js** – Next-gen frontend tooling for super-fast development.  \n- **Tailwind CSS** – Modern styling with utility-first CSS.  \n- **Framer Motion** – Smooth animations and enhanced UI interactions (if used).  \n\n### ⚙️ Backend\n- **Node.js** – Asynchronous event-driven runtime.  \n- **Express.js** – Lightweight web framework for API handling.  \n- **MongoDB** – NoSQL database for storing notes.  \n- **Mongoose ODM** – Elegant MongoDB object modeling for Node.js.  \n\n### 🐳 Docker (Containerized Setup)\n- **Docker** – Containerized deployment for easy environment setup.  \n- **Docker Compose** – Multi-container setup with one command.  \n\n## 🛠️ Installation Guide\n### ✅ Prerequisites\nMake sure you have the following installed before running the app:\n- [Node.js](https://nodejs.org/)\n- [Docker](https://www.docker.com/)\n\n### 🚀 Getting Started\n1️⃣ **Clone the Repository:**  \n   ```sh\n   git clone https://github.com/tejas-130704/docs.git\n   cd docs\n   ```\n\n2️⃣ **Run with Docker:**  \n   ```sh\n   docker-compose up --build\n   ```\n\n3️⃣ **Access the Application:**  \n   - 🌐 Open the frontend at: `http://localhost:5173/`\n   - 🔗 Backend API runs on: `http://localhost:3000/`\n\n4️⃣ **Stopping the Containers:**  \n   ```sh\n   docker-compose down\n   ```\n\n## 🔧 Manual Setup (Without Docker)\nIf you prefer running the app manually, follow these steps:\n\n### 🚀 Backend Setup\n```sh\ncd backend\nnpm install\nnpm start\n```\n\n### 🎨 Frontend Setup\n```sh\ncd frontend\nnpm install\nnpm run dev\n```\n\n## 📂 Project Structure\n```\n📦 notes-app\n ┣ 📂 backend\n ┃ ┣ 📂 models         # Database models\n ┃ ┣ 📂 routes         # API routes\n ┃ ┣ 📜 server.js      # Express app\n ┃ ┗ 📜 Dockerfile     # Backend Docker setup\n ┣ 📂 frontend\n ┃ ┣ 📂 src            # React components\n ┃ ┣ 📜 App.jsx        # Main React app\n ┃ ┗ 📜 Dockerfile     # Frontend Docker setup\n ┣ 📜 docker-compose.yml  # Docker multi-container setup\n ┣ 📜 README.md         # Project documentation\n```\n--\n\n## 📹 Video Overview\n🎥 Watch a quick demo of the app in action:  \n\nhttps://github.com/user-attachments/assets/da03a6e6-cd52-4d2a-85be-b6ba97929143\n\n\n---\n\n## 🛠️ Future Enhancements\n🚀 **User Authentication** – Secure login \u0026 signup.  \n🚀 **Dark Mode** – Switch between light and dark themes.  \n🚀 **Cloud Sync** – Sync notes across multiple devices.  \n🚀 **Drag \u0026 Drop** – Reorder notes with ease.  \n\n## 🤝 Contributing\nWe welcome contributions! Feel free to **fork** the repo, make changes, and submit a **pull request**.\nFor major changes, please open an **issue** first to discuss your ideas.\n\nHappy Coding! 🚀\n\n\n\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftejas-130704%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftejas-130704%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftejas-130704%2Fdocs/lists"}