Campus Communities

An Open Source Platform Connecting Students Within an Institute for Academic and Personal skill growth
Explore the docs »

Download apk · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Campus Communities is a Flutter-based app designed to connect students within their institute, fostering collaboration and resource sharing. With Campus Communities, students can effortlessly connect with peers, access and share notes, and utilize various academic tools like a CGPA calculator.

Key Features:

• Student Connection: Easily connect with other students from your institute.
• Notes Sharing: Access a repository of notes and contribute by uploading your own.
• CGPA Calculator: Calculate and keep track of your CGPA/SGPA with an integrated calculator.
• Additional Features: More Featues are yet to come !

Campus Communities is open source and aims to create a supportive and collaborative environment for students. Join us in building a more connected academic community!

(back to top)

Built With

• 
• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• Flutter SDK
• Android Studio
• VS Code (or other IDE)
• Android SDK (For Android Emulator)

Refer to this guide for setting up your Environment

Installation

1. Get the Supabase URL and API by sending a mail to : campus-communities-hrishi-admin-01@proton.me
2. Clone the repo

   git clone https://github.com/neo-0007/CampusCommunities

3. Install packages

   flutter pub get

4. Replace the AppSecretsTemplete.dart with the file recived in mail

Now You are all set to build and contribute !

(back to top)

Usage

(back to top)

Roadmap

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Hrishikesh Gohain

Project Link: Campus Communities

(back to top)

Acknowledgments

(back to top)