{"id":15857351,"url":"https://github.com/eimaam/get-notes","last_synced_at":"2026-05-05T11:35:18.106Z","repository":{"id":135848306,"uuid":"536372169","full_name":"eimaam/get-notes","owner":"eimaam","description":"A mini School Library built for the purpose of bringing ease to Students by bringing all their Lecture Notes/Documents into an easy to navigate environment with almost their full controll","archived":false,"fork":false,"pushed_at":"2024-01-03T10:43:00.000Z","size":3646,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"v1.1","last_synced_at":"2025-02-07T12:46:51.919Z","etag":null,"topics":["e-library","firebase","react"],"latest_commit_sha":null,"homepage":"https://getnotes.eimaam.dev","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/eimaam.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":"2022-09-14T01:40:25.000Z","updated_at":"2023-01-15T06:43:51.000Z","dependencies_parsed_at":"2024-01-03T11:46:51.325Z","dependency_job_id":"fb9d26ef-289c-42a6-98e8-0a573b79c3c5","html_url":"https://github.com/eimaam/get-notes","commit_stats":{"total_commits":125,"total_committers":2,"mean_commits":62.5,"dds":0.03200000000000003,"last_synced_commit":"b53bc780e1afed33e3a02511220913956eed8e08"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eimaam%2Fget-notes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eimaam%2Fget-notes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eimaam%2Fget-notes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eimaam%2Fget-notes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eimaam","download_url":"https://codeload.github.com/eimaam/get-notes/tar.gz/refs/heads/v1.1","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246701289,"owners_count":20820033,"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":["e-library","firebase","react"],"created_at":"2024-10-05T20:22:27.553Z","updated_at":"2026-05-05T11:35:18.071Z","avatar_url":"https://github.com/eimaam.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ca name=\"readme-top\"\u003e\u003c/a\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"https://firebasestorage.googleapis.com/v0/b/myportfolio-1b84c.appspot.com/o/projects%2Fget-notes-banner.svg?alt=media\u0026token=8c75be4d-1412-4368-962e-19b0360facac\" alt=\"logo\" width=\"140\"  height=\"auto\" /\u003e\n  \u003cbr/\u003e\n\n  \u003ch3\u003e\u003cb\u003egetNOTES | Student Social e-Library\u003c/b\u003e\u003c/h3\u003e\n\n\u003c/div\u003e\n\n\u003c!-- TABLE OF CONTENTS --\u003e\n\n# 📗 Table of Contents\n\n- [📖 About the Project](#about-project)\n  - [🛠 Built With](#built-with)\n    - [Tech Stack](#tech-stack)\n    - [Key Features](#key-features)\n  - [🚀 Live Demo](#live-demo)\n- [💻 Getting Started](#getting-started)\n  - [Setup](#setup)\n  - [Prerequisites](#prerequisites)\n  - [Install](#install)\n  - [Usage](#usage)\n  - [Run tests](#run-tests)\n  - [Deployment](#triangular_flag_on_post-deployment)\n- [👥 Authors](#authors)\n- [🔭 Future Features](#future-features)\n- [🤝 Contributing](#contributing)\n- [⭐️ Show your support](#support)\n- [🙏 Acknowledgements](#acknowledgements)\n- [❓ FAQ (OPTIONAL)](#faq)\n- [📝 License](#license)\n\n\u003c!-- PROJECT DESCRIPTION --\u003e\n\n# 📖 getNOTES \u003ca name=\"about-project\"\u003e\u003c/a\u003e\n\n**getNOTES** is a Fullstack WebApp - mini e-library platform that allows the sharing of Notes in different formats (pdf, ppt, txt, docx, mp3 etc) from digital to audio notes. Built purposely to ease access to Lecture notes in the Faculty of Engineering (My Faculty) in my Institute. Notes are uploaded by the Students themselves and managed by an Admin.\n\n## 🛠 Built With \u003ca name=\"built-with\"\u003e\u003c/a\u003e\n\n### Tech Stack \u003ca name=\"tech-stack\"\u003e\u003c/a\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003eClient\u003c/summary\u003e\n  \u003cul\u003e\n    \u003cli\u003e\u003ca href=\"https://reactjs.org/\"\u003eReact.js\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"https://sass.org/\"\u003eSASS\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#\"\u003eReact Toastify\u003c/a\u003e\u003c/li\u003e\n  \u003c/ul\u003e\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003eServer\u003c/summary\u003e\n  \u003cul\u003e\n    \u003cli\u003e\u003ca href=\"https://console.firebase.com/\"\u003eFirebase\u003c/a\u003e\u003c/li\u003e\n  \u003c/ul\u003e\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003eDatabase\u003c/summary\u003e\n  \u003cul\u003e\n    \u003cli\u003e\u003ca href=\"https://www.firebase.com/\"\u003eFireStore\u003c/a\u003e\u003c/li\u003e\n  \u003c/ul\u003e\n\u003c/details\u003e\n\n\u003c!-- Features --\u003e\n\n### Key Features \u003ca name=\"key-features\"\u003e\u003c/a\u003e\n\n\n- **Upload/Add Notes**\n- **Games Forum**\n- **Forum - With over 10 Groups**\n- **Sign Up**\n- **Profile - Unique Username**\n- **Profile Management**\n- **Announcement Page**\n\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- LIVE DEMO --\u003e\n\n## 🚀 Live Demo \u003ca name=\"live-demo\"\u003e\u003c/a\u003e\n\n- [Live Demo Link](https://getnotes.xyz)\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- GETTING STARTED --\u003e\n\n## 💻 Getting Started \u003ca name=\"getting-started\"\u003e\u003c/a\u003e\n\nTo get a local copy up and running, follow these steps.\n\n### Prerequisites\n\nIn order to run this project you need:\n- Firebase Account\n\n\u003c!--\nExample command:\n\n```sh\n gem install rails\n```\n --\u003e\n\n### Setup\n\nClone this repository to your desired folder:\n\nExample commands:\n\n```sh\n  cd my-folder\n  git clone https://github.com/eimaam/get-notes.git\n```\n\n- Create `New Project` in Firebase Console\n- Create `.env.local` file and paste the new firebase project configuration data according using the format `REACT_APP_API_KEY= x132434`\n\n### Install\n\nInstall this project with:\n\n Use `npm install` or `yarn install`\n```sh\n  cd my-project\n  npm install\n```\n\n### Usage\n\nTo run the project, execute the following command:\n\n\n```sh\n  npm run start\n```\n\n### Deployment\n\nYou can deploy this via Firebase or Vercel (make sure to add the env variables via Vercel settings environment variables)\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- FUTURE FEATURES --\u003e\n\n## 🔭 Future Features \u003ca name=\"future-features\"\u003e\u003c/a\u003e\n\n\n- [ ] **Make open to all Faculties in the Institute**\n- [ ] **Integrate a marketplace**\n- [ ] **Add a Poll to the Forum**\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- SUPPORT --\u003e\n\n## ⭐️ Show your support \u003ca name=\"support\"\u003e\u003c/a\u003e\n\nIf you like this project kindly share and recommend my brand for Works.\n\n\n\u003c!-- LICENSE --\u003e\n\n## 📝 License \u003ca name=\"license\"\u003e\u003c/a\u003e\n\nThis project is [MIT](./LICENSE) licensed.\n\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feimaam%2Fget-notes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feimaam%2Fget-notes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feimaam%2Fget-notes/lists"}