Companion App

Companion App is a mobile application built using Flutter, Node.js, and Supabase. It allows students to easily organize and share digital documents among a community of people. Students can rate the quality of digital documents shared and have all their notes present under one application.

Table of Contents

• Features
• Installation
• Design
• Usage
• Contributing
• License
• Contact

Features

• Upload and share digital documents (pdf)
• Personal notes management
• Secure login and authentication
• Community Chat

Tech Stack

• Flutter [Front-end]
• Node.js (Express) [Backend]
• Supabase [User database]
• MongoDB [Files database]
• AMAZON S3 [File objects]
• Google Firebase [Real-time messaging]

Installation

To run the app, follow these steps:

1. Clone the repository: git clone https://github.com/tanishq5414/Companion.git
2. Install dependencies for the frontend and backend by running the following commands in separate terminal windows:
   • flutter pub get
3. Create a Firebase project and enable Supabase database and Authentication.
4. Add your Firebase project's google-services.json file to the /android/app directory.
5. Run the app on a device or emulator by running flutter run.
6. The endpoints are relevant to the backend of this application which will is available at https://github.com/kaamilmirza/notesapp-backend (also open-source)

Usage

To use the app, create an account and log in. You can then upload and share digital documents, rate and provide feedback on documents shared by others, and manage your personal notes. You can also communicate with other students using the community chat feature.

Design

The figma design file of this app is available at https://www.figma.com/file/E2kq9JcsduEksaxnZx1OKE/Companion-(Design-Prototypes)?type=design&node-id=0%3A1&t=HzbU5JQ2nCQCbxyP-1

Contributing

Contributions to Companion App are welcome and encouraged! To contribute, follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bug fix: git checkout -b my-new-feature.
3. Make changes and commit them: git commit -am 'Add some feature'.
4. Push to the branch: git push origin my-new-feature.
5. Submit a pull request.

License

Companion App is licensed under the MIT License. See the LICENSE file for more information.

Download

Download the app on the Play Store: https://play.google.com/store/apps/details?id=com.lightheads.companion.app

Contact

Kindly contact us regarding any queries or assitance regarding contributing to this repository.

Kaamil kaamil@lightheads.org https://www.linkedin.com/in/kaamil-mirza/

Tanishq tanishq@lightheads.org https://www.linkedin.com/in/tanishqagarwal/

Contributors

Thank you!

<a href="[https://github.com/tanishq5414/Companion]/graphs/contributors"> <img src="https://contrib.rocks/image?repo=tanishq5414/Companion" /> </a> <br/>