Skip to content

Latest commit

 

History

History
107 lines (66 loc) · 3.83 KB

README.md

File metadata and controls

107 lines (66 loc) · 3.83 KB
Raw

campUS-flutter

A University based community building app cum website that enables students on campus to help each other and gain points, resulting in them being more recognized. Students can post their requests, and other people on campus can view their requests and attend to their requests, enabling students on campus to assist each other at times of need, while ensuring that they form valuable connections and networks in the process.

Project Structure

-my_flutter_app/
-android/: Native Android code and configuration
-ios/: Native iOS code and configuration
-lib/: Dart code for the application
-main.dart: Entry point of the Flutter app
-test/: Unit and widget tests
-assets/: Static assets like images, fonts, and JSON files
-build/: Build artifacts (automatically generated)
-doc/: Documentation (if any)
-web/: Web-specific code and assets (if applicable)
-.gitignore: Git ignore file for specifying ignored files and directories
-pubspec.yaml: Flutter project configuration
-README.md: Project-specific documentation (this file)

Tech stack used:

The tech stack used here is:

  • Flutter
  • Google Firebase

Before contributing look into CONTRIBUTING GUIDELINES

Our Code of Conduct: CODE OF CONDUCT

Project setup instructions:

  • Fork the repository to your GitHub account by clicking the "Fork" button at the top-right corner of this page. This will create a copy of the repository under your account.

  • Clone your forked repository to your local machine using Git. Replace your-username with your GitHub username:

    ` git clone https://github.com/your-username/campUS-Web.git

    `

  • Install project dependencies using (Flutter Package Manager): flutter pub get

  • Create a new branch for your contribution. Replace 'feature/your-feature-name' with a descriptive branch name related to your contribution:

Development

  • Make your changes or additions to the codebase. Test your changes to ensure they work as expected. To run the website on your Emulator

  • Commit your changes with a descriptive commit message: git commit -m "Add your descriptive message here"

Push Changes

  • Push your changes to your forked repository on GitHub: git push origin feature/your-feature-name

Getting started with contributions

  • Create a Pull Request (PR)

Visit the campUS-flutter repository on GitHub. Click the "Compare & pull request" button next to your recently pushed branch. Follow the PR template and guidelines. Provide details about your changes. Submit the PR.

  • Review and Merge

The maintainers will review your PR and may request changes or provide feedback. Once your PR is approved, it will be merged into the main repository.

Final version of the project

Click here for the UI design and prototype of the project.

Intended final project:

A responsive and aesthetically designed university-community building website called campUS(Flutter version).

Thank You

Thank you for contributing to campUS-flutter! Your contributions help make this project better for everyone. If you have any questions or need further assistance, please don't hesitate to reach out to us.

Maintainers

  1. Sanjay M