Skip to content

snig-code16/NotesWallah

Repository files navigation

NotesWallah - Class Notes and Study Music Sharing Platform πŸ“šπŸŽΆ

GitHub stars GitHub forks GitHub issues GitHub pull requests GitHub license GitHub contributors

NotesWallah is a feature-rich Flask-based platform designed for sharing class notes and study music. It provides a seamless and secure environment for students to collaborate, learn, and enjoy music tailored to their study sessions.

notesWallahHomePage

Key Features πŸš€

  • User Authentication System: A robust user authentication system ensures secure access to the platform. Users can create accounts, log in, and manage their profiles effectively.

  • File Preview and Download System: Users can preview files directly on the platform before deciding to download them. This feature enhances the user experience by providing a quick overview of the content.

  • Embedded YouTube Videos in Music Section: The music section allows users to share study playlists by embedding YouTube videos. This feature adds a dynamic and engaging element to the platform.

  • User Profile Control: Users have control over their profiles, including the ability to update personal information such as name and email, upload a profile picture, and change their passwords.

  • Highest User Data Security: The platform prioritizes user data security by implementing password hashing. This ensures that user passwords are securely stored.

  • Scalability: NotesWallah is designed with scalability in mind, allowing it to accommodate a growing user base and expanding content seamlessly.

Getting Started πŸ› οΈ

To run the NotesWallah platform locally, follow these steps:

  1. Clone the repository:

    git clone https://github.com/Akash-nath29/NotesWallah.git
  2. Install the required dependencies:

    pip install -r requirements.txt
  3. Configure the database settings Open command prompt, and follow the following commands

    flask shell
    from app import db
    db.create_all()
    exit()
  4. Run the application:

    python app.py

    The platform will be accessible at http://127.0.0.1:6010.

Contributing 🀝

Contributions are welcome! To contribute to NotesWallah, follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature: git checkout -b feature-name.
  3. Commit your changes: git commit -m 'Add some feature'.
  4. Push to your branch: git push origin feature-name.
  5. Submit a pull request.

Community and Support 🌐

  • Report Issues: If you encounter any issues or have suggestions for improvements, please open an issue.

  • Community: Join the community discussions and get support on GitHub Discussions.

License πŸ“

NotesWallah is open-source and available under the MIT License.


Feel free to explore, contribute, and make NotesWallah your own! Happy learning and studying! πŸ“šπŸŽΆ

About

Online study material sharing platform made in flask

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published