Skip to content

Latest commit

 

History

History
93 lines (84 loc) · 3.61 KB

README.md

File metadata and controls

93 lines (84 loc) · 3.61 KB



notex

NoteX

An open source easy-to-use social media application for students to study, share resources, connect with each other, find opportunities and grow. A single platform to cater to all the needs of a student.

Discord   •   Twitter   •   Email

Features 🦸‍♂️

It is a complete package for a college student who wants to manage his academics and ambitions efficiently.

  • Share Notes and Resources with each other 📖
  • Connect with each other 🤝
  • Find information about 🕵️
    • Upcoming Hackthons 💻
      • With the help of our custom API
    • Open Source programs 👨‍💻
    • Internship opportunities 💸
  • Download resources on your device ⬇️
  • Cool user interface 😎

Tech Dependencies 👨‍💻

                                            

Build Instructions 🛠️

Follow the instructions to run the app in your own system

  1. Clone the repository using git clone
git clone https://github.com/Tech-Emcees/NoteX.git
  1. Change directory to the cloned repository
    cd NoteX/
  2. Update dependencies
    flutter pub get
  3. Run the app
    flutter run

Contribution Guidelines 🗒️

To contribute to this repository, follow the given steps :

  • Clone the repositoy in your local system.
  • Go through the application and find issues or features that you wish to add.
  • Go to issues and create your issue.
  • Wait for issue to be assigned.
  • Work on your issue
  • Create a pull request
  • Wait for it to be reviewed and merged
  • Congratulations !! You have just contributed to NoteX.

Our Team 🚀

@TeeWrath      @bhaskar1001101      @ImanKalyanChakraborty      @shashwatdwi176      @RJ-04