Skip to content

Latest commit

 

History

History
186 lines (131 loc) · 5.75 KB

README.md

File metadata and controls

186 lines (131 loc) · 5.75 KB

UNI-Share - A Media Sharing App for Students

Welcome to UNI-Share, the media sharing app that helps students share and access resources and materials with the fellow students at their institute.

With UNI-Share, you can easily share notes, assignments, tutorials, notices, and more with your fellow students. The app supports a wide range of file formats, including PDF, Word documents and audio files, so you can share whatever resources you have on hand.

One of the key feature of UNI-Share is the ability to notify all students at your institute whenever a new media content is uploaded. This ensures that everyone stays up-to-date with the latest resources and materials, and helps to foster a sense of community among students.

In addition to sharing resources with the entire institute, you can also use UNI-Share to have private chats with other students. This allows you to discuss and collaborate on projects and assignments in real-time, and provides a convenient way to stay connected with your peers.

To get started with UNI-Share, simply download the app from the App Store or Google Play, and create an account using your institute's email address. From there, you can start sharing resources and chatting with other students right away.

Overall, UNI-Share is a powerful tool for students looking to share and access resources and materials with their fellow students. Give it a try today and see how it can help you succeed in your studies!

Ideas and suggestions are welcome, Connect with me on: discord Tag me: @benihimearatamee , Email - nitinsharmaa787@gmail.com

Tech Stack

Checkout the UI map HERE
APK v1.1.0 HERE

Getting Started

Make sure you have installed Firebase cli before starting the project setup.

Firebase Documentation:
https://firebase.google.com/docs/cli#setup_update_cli

Alternatively you could look into this YouTube video for futher help for the Firebase Setup: https://www.youtube.com/watch?v=dIK5MNvaxeY&t

Setup firebase with flutter with the following commands:

firebase login
dart pub global activate flutterfire_cli

Configure your apps to use Firebase

 your-flutter-proj$ flutterfire configure (select your project or create a new one)

  1. To download and install the Firebase CLI run the following command:

    npm install -g firebase-tools
  2. Create a Firebase project

    firebase login
    firebase init
  3. Add Firebase config to your project

  4. Run the app

    flutter run

Development Setup

  1. Clone the repository

    git clone
  2. Install dependencies

    flutter pub get
  3. Run the app

    flutter run

NOTE: If you've just created a new firebase account this command will not work for you. You will have to create a firebase project manually on your account
After creating a project, go inside it
→ Click on authentication → a sign-in method tab → add provider email/password → enable email/password

Initialize Firebase in your app

  your-flutter-proj$ flutter pub add firebase_core
  your-flutter-proj$ flutterfire configure

How to contribute?

If you want to contribute to this project then you can fork this project and then you can create a pull request.

1. Fork this repository
2. Clone your forked copy of the project.

git clone https://github.com/<your_username>/mynotes.git

3. Navigate to the project directory 📁 .

cd mynotes

4. Add a reference(remote) to the original repository.

git remote add upstream https://github.com/anjali1102/mynotes.git

5. Check the remotes for this repository.

git remote -v

6. Always take a pull from the upstream repository to your master branch to keep it at par with the main project(updated repository).

git pull upstream main

7. Create a new branch.

git checkout -b <your_branch_name>

8. Perfom your desired changes to the code base. 9. Track your changes:heavy_check_mark: .

git add . 

10. Commit your changes .

git commit -m "Relevant message"

11. Push the committed changes in your feature branch to your remote repo.

git push -u origin <your_branch_name>

12. To create a pull request, click on Compare and pull requests. Please ensure you compare your feature branch to the desired branch of the repo you are suppose to make a PR to.

13. Add appropriate title and description to your pull request explaining your changes and efforts done.

14. Click on Create Pull Request.

15. Voila! You have made a PR to the awesome-developer-portfolio project. Sit back patiently and relax while the your PR is reviewed. This may take sometime.

Look into CONTRIBUTING.md for further clarifications

Project Maintainer 🙂


Nitin Sharma

Contributors ❤️

Thank you!


License: MIT