Skip to content

README.md

Latest commit

 

History

History
100 lines (67 loc) · 3.26 KB

README.md

File metadata and controls

100 lines (67 loc) · 3.26 KB

Noteng - All Your Notes in One Place

🚀 Quick Links

📚 About Noteng

Noteng is a revolutionary knowledge-sharing platform built by students, for students. It centralizes academic resources, career opportunities, and campus events in one seamless interface, empowering college students to excel in their academic journeys.

Our mission is to transform the college experience through collaborative learning and resource sharing, creating a community where knowledge flows freely between seniors and juniors.

✨ Features

📝 Note Sharing

Access premium notes from seniors across different years and subjects, with a rating system for quality assurance.

💼 Job Opportunities

Discover internships and job openings posted by seniors and alumni with direct contact information.

🎥 Video Resources

Access curated YouTube videos for specific subjects and topics with embedded player functionality.

📅 Events Calendar

Stay updated with campus events, workshops, hackathons, and important academic dates.

💬 Chat with PDF

Collaborate in real-time while viewing PDFs, enhancing group study sessions and discussions.

📱 Cross-Platform

Seamlessly switch between our responsive web platform and dedicated mobile application.

🛠️ Technology Stack

  • Frontend: React.js
  • Mobile App: Flutter
  • Backend: Python (Flask/Django)
  • Animations: AOS (Animate On Scroll)
  • UI Components: React-Slick, Font Awesome
  • Deployment: Vercel (Frontend), PythonAnywhere (Backend)

🔧 Installation & Setup

Prerequisites

  • Node.js (v14.0+)
  • npm or yarn

Web Application Setup

# Clone the repository
git clone https://github.com/yourusername/noteng.git

# Navigate to project directory
cd noteng

# Install dependencies
npm install

# Start development server
npm start

Mobile Application

Download the APK directly from our Google Drive link and install on your Android device.

🌟 Project Stats

  • 50+ Students actively using the platform
  • 100+ Notes shared across various subjects
  • 200+ Opportunities posted for students

👨‍💻 Contributing

We welcome contributions to Noteng! If you'd like to contribute, please:

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

📫 Contact

Got questions or feedback? Reach out to us:

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

© 2023 Noteng. All rights reserved.
Empowering students through knowledge sharing