{"id":27391519,"url":"https://github.com/majorh5/terpnotes","last_synced_at":"2026-04-13T03:08:02.972Z","repository":{"id":287674588,"uuid":"965332266","full_name":"MajorH5/TerpNotes","owner":"MajorH5","description":"AI-powered note sharing and discovery platform for UMD students.","archived":false,"fork":false,"pushed_at":"2025-04-13T13:58:03.000Z","size":11277,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-13T20:56:08.647Z","etag":null,"topics":["education","firebase","gemini-api","mongodb","nextjs","python","react"],"latest_commit_sha":null,"homepage":"https://terpnotes.tech","language":"TypeScript","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/MajorH5.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,"zenodo":null}},"created_at":"2025-04-12T23:25:09.000Z","updated_at":"2025-04-13T13:58:07.000Z","dependencies_parsed_at":"2025-04-13T09:29:26.692Z","dependency_job_id":null,"html_url":"https://github.com/MajorH5/TerpNotes","commit_stats":null,"previous_names":["majorh5/terpnotes"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MajorH5%2FTerpNotes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MajorH5%2FTerpNotes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MajorH5%2FTerpNotes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MajorH5%2FTerpNotes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MajorH5","download_url":"https://codeload.github.com/MajorH5/TerpNotes/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248782279,"owners_count":21160716,"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":["education","firebase","gemini-api","mongodb","nextjs","python","react"],"created_at":"2025-04-13T20:56:14.455Z","updated_at":"2026-04-13T03:08:02.929Z","avatar_url":"https://github.com/MajorH5.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# TerpNotes\n\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"frontend/public/assets/images/logo.svg\" alt=\"TerpNotes Logo\" width=\"200\"\u003e\n\u003c/p\u003e\n\nTerpNotes is a collaborative note-sharing platform designed to help students share and access study materials efficiently. This project was developed as part of the University of Maryland's 2025 Bitcamp Hackathon.\n\n## Table of Contents\n\n- [About the Project](#about-the-project)\n- [Features](#features)\n- [Tech Stack](#tech-stack)\n- [Getting Started](#getting-started)\n  - [Prerequisites](#prerequisites)\n  - [Installation](#installation)\n- [Usage](#usage)\n- [Deployment](#deployment)\n- [Contributing](#contributing)\n\n---\n\n## About the Project\n\nTerpNotes is a platform that allows students to upload, browse, and share notes for various courses. It aims to foster collaboration and improve academic success by providing a centralized repository for study materials.\n\nThis project was built during the University of Maryland's 2025 Bitcamp Hackathon, showcasing teamwork, innovation, and technical expertise.\n\n---\n\n## Features\n\n- **User Authentication**: Secure login and registration system.\n- **Note Sharing**: Upload and share notes with peers.\n- **Search and Browse**: Easily find notes by course or topic.\n- **Responsive Design**: Optimized for both desktop and mobile devices.\n- **Privacy Controls**: Users can manage the visibility of their notes.\n\n---\n\n## Tech Stack\n\n- **Frontend**: React, Next.js\n- **Backend**: Firebase Firestore, Python, MongoDB\n- **Deployment**: AWS EC2\n- **CI/CD**: GitHub Actions\n\n---\n\n## Getting Started\n\nFollow these instructions to set up the project locally.\n\n### Prerequisites\n\n- Node.js (v16 or later)\n- npm or yarn\n- Git\n- An AWS EC2 instance (for deployment)\n\n### Installation\n\n1. Clone the repository:\n\n   ```bash\n   git clone https://github.com/MajorH5/TerpNotes.git\n   cd TerpNotes\n   ```\n\n2. Install dependencies:\n\n   ```bash\n   cd frontend\n   npm install\n   ```\n\n3. Set up Firebase:\n\n   - Create a Firebase project.\n   - Enable Firestore and Authentication.\n   - Add your Firebase configuration to `frontend/src/lib/firebase-config.js`.\n\n4. Start the development server:\n\n   ```bash\n   npm run dev\n   ```\n\n   The app will be available at `http://localhost:3000`.\n\n---\n\n## Usage\n\n1. **Sign Up**: Create an account using your email.\n2. **Upload Notes**: Share your notes by uploading them to the platform.\n3. **Browse Notes**: Search for notes by course or topic.\n4. **Collaborate**: Share links to notes with your peers.\n\n---\n\n## Deployment\n\nThe project is configured for deployment on AWS EC2 using GitHub Actions.\n\n### Steps to Deploy\n\n1. Add the following secrets to your GitHub repository:\n   - `EC2_SSH_PRIVATE_KEY`: Your EC2 instance's private SSH key.\n   - `EC2_USER`: The username for your EC2 instance (e.g., `ubuntu`).\n   - `EC2_HOST`: The public IP address of your EC2 instance.\n\n2. Push changes to the `main` branch. The GitHub Actions workflow (`.github/workflows/deploy.yml`) will automatically deploy the latest code to your EC2 instance.\n\n---\n\n## Contributing\n\nContributions are welcome! Follow these steps to contribute:\n\n1. Fork the repository.\n2. Create a new branch:\n\n   ```bash\n   git checkout -b feature/your-feature-name\n   ```\n\n3. Commit your changes:\n\n   ```bash\n   git commit -m \"Add your message here\"\n   ```\n\n4. Push to your branch:\n\n   ```bash\n   git push origin feature/your-feature-name\n   ```\n\n5. Open a pull request.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmajorh5%2Fterpnotes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmajorh5%2Fterpnotes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmajorh5%2Fterpnotes/lists"}