{"id":20119726,"url":"https://github.com/muhammad-tayyab-awan/inotebook","last_synced_at":"2025-05-06T14:32:40.990Z","repository":{"id":259659139,"uuid":"863392523","full_name":"Muhammad-Tayyab-Awan/inotebook","owner":"Muhammad-Tayyab-Awan","description":"I have Created online platform where you can register and keep your notes save and secure on cloud","archived":false,"fork":false,"pushed_at":"2025-04-23T01:59:10.000Z","size":505,"stargazers_count":8,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-23T02:38:04.319Z","etag":null,"topics":["backend-web-development","expressjs","front-end-web-development","mongodb","mongoose","nodejs-server","nodemailer","react-hot-toast","react-router","reactjs"],"latest_commit_sha":null,"homepage":"https://inotebook-project.vercel.app/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Muhammad-Tayyab-Awan.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":null,"patreon":null,"open_collective":"mtayyabrawan26","ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"lfx_crowdfunding":null,"polar":null,"buy_me_a_coffee":null,"thanks_dev":null,"custom":null}},"created_at":"2024-09-26T08:09:16.000Z","updated_at":"2025-04-23T01:59:13.000Z","dependencies_parsed_at":"2024-10-27T06:40:45.006Z","dependency_job_id":"54c3e2cb-12b6-4bdb-9b3a-82d9fd28243c","html_url":"https://github.com/Muhammad-Tayyab-Awan/inotebook","commit_stats":null,"previous_names":["muhammad-tayyab-awan/inotebook"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Muhammad-Tayyab-Awan%2Finotebook","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Muhammad-Tayyab-Awan%2Finotebook/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Muhammad-Tayyab-Awan%2Finotebook/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Muhammad-Tayyab-Awan%2Finotebook/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Muhammad-Tayyab-Awan","download_url":"https://codeload.github.com/Muhammad-Tayyab-Awan/inotebook/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252703456,"owners_count":21790888,"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":["backend-web-development","expressjs","front-end-web-development","mongodb","mongoose","nodejs-server","nodemailer","react-hot-toast","react-router","reactjs"],"created_at":"2024-11-13T19:16:44.946Z","updated_at":"2025-05-06T14:32:40.985Z","avatar_url":"https://github.com/Muhammad-Tayyab-Awan.png","language":"JavaScript","funding_links":["https://opencollective.com/mtayyabrawan26"],"categories":[],"sub_categories":[],"readme":"# iNotebook\n\n## An Online Notekeeping Application\n\n**iNotebook** is a responsive online platform where users can manage their notes securely on the cloud. The application offers features like registration, login, note management, and a theme toggle between dark and light modes.\n\n---\n\n### Features\n\n- **User Registration**: Create a personal account to manage your notes.\n- **Verify Your Email**: Verify your email during first login.\n- **Note Management**: Add, edit, and delete notes. Each note includes:\n  - A title\n  - A description\n  - A tag (default is \"General\")\n- **Read Note**: You can also read a particular note with detail.\n- **Daily Limit**: Each user can daily add only **50** notes.\n- **Filter**: User can also filter notes by tags.\n- **Account Sidebar**: User can easily see his profile details by opening that sidebar.\n- **Update Profile**: User can also update his profile information (name, email).\n- **404 Page Not Found**: Also shows 404 error incase of wrong page request.\n- **Theme Switcher**: Toggle between light and dark themes.\n- **Responsive Design**: The site is fully responsive across different screen sizes.\n- **Authentication**: Login and logout functionality for secure access.\n\n---\n\n### Getting Started\n\n#### Steps to run iNotebook on your local machine\n\n1. **Clone the repository**  \n   Open a terminal and run the following command:\n\n   ```bash\n   git clone https://github.com/Muhammad-Tayyab-Awan/inotebook\n   ```\n\n2. **Open the project**  \n   Use your favorite code editor to open the cloned repository.\n\n3. **Install dependencies**  \n   Navigate to the project folder in your terminal and install the required Node.js dependencies:\n\n   ```bash\n   npm install\n   ```\n\n4. **Run the development server**  \n   Start the frontend development server by running:\n\n   ```bash\n   npm run dev\n   ```\n\n   Make sure **npm** is installed on your system.\n\n   After running the command, the frontend will be hosted locally, and a link to the app will appear in the terminal.\n\n   **Access the frontend at:**\n\n   ```https\n   http://localhost:5173\n   ```\n\n### Backend Setup\n\nTo start the backend server, follow the instructions provided in the [Backend Guide](./backend/Backend.md).\n\n---\n\n### Technologies Used in **iNotebook**\n\n#### Frontend\n\n- **React.js**:\n\n  - React Router DOM (for routing)\n  - React Top Loading Bar (for progress indication)\n  - React Hot Toast (for notifications)\n\n- **Tailwind CSS**: For building the UI with responsive design.\n\n#### Backend\n\n- **Express.js**: For building the server-side logic.\n- **Mongoose**: For managing MongoDB interactions.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmuhammad-tayyab-awan%2Finotebook","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmuhammad-tayyab-awan%2Finotebook","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmuhammad-tayyab-awan%2Finotebook/lists"}