Giter VIP home page Giter VIP logo

gdsc-jssstu / campus-flutter Goto Github PK

View Code? Open in Web Editor NEW
0.0 0.0 3.0 343 KB

A university based community building app/website that enables students on campus to help each other and gain points, resulting in them being more recognized

License: BSD 2-Clause "Simplified" License

Kotlin 0.26% Swift 2.31% Objective-C 0.08% Dart 11.95% CMake 37.24% C++ 41.68% C 2.84% HTML 3.65%
hacktoberfest opensource firebase hacktoberfest2023

campus-flutter's Introduction

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

campus-flutter's People

Contributors

sanjay14073 avatar sikehish avatar

campus-flutter's Issues

Creating the Home Screen

The UI/UX design for the app is here
https://www.figma.com/proto/fg2pUtJ4oJmUfScwGD7oRo/CampusUs-Mobile-version?page-id=0%3A1&type=design&node-id=2-1718&viewport=646%2C313%2C0.12&t=tqwzJk8lSFjigPaY-1&scaling=scale-down&starting-point-node-id=2%3A1718&mode=design

Building the HomeScreen
Build the Home Screen according to the UI/UX design.

You can Enhance this feature by creating a util folder and making it a resuable component
Your Pull request you only be accepted if your answer is compilling without any issues and solves the raised issue

Creating a Login/Signup page

The UI/UX design for the app is here
https://www.figma.com/proto/fg2pUtJ4oJmUfScwGD7oRo/CampusUs-Mobile-version?page-id=0%3A1&type=design&node-id=2-1718&viewport=646%2C313%2C0.12&t=tqwzJk8lSFjigPaY-1&scaling=scale-down&starting-point-node-id=2%3A1718&mode=design

Adding an Login page
Build the Login according to the UI/UX design.

Adding a Signup page
Build the Signup and add the components accroding to the UI/UX design

You can Enhance this feature by creating a util folder and making it a resuable component
Your Pull request you only be accepted if your answer is compilling without any issues and solves the raised issue

Create an User Model for App

The UI/UX design for the app is here
https://www.figma.com/proto/fg2pUtJ4oJmUfScwGD7oRo/CampusUs-Mobile-version?page-id=0%3A1&type=design&node-id=2-1718&viewport=646%2C313%2C0.12&t=tqwzJk8lSFjigPaY-1&scaling=scale-down&starting-point-node-id=2%3A1718&mode=design

Creating the user model
Create an User Model that consists of the following fields
Name
Year
Contact Number
Issue
Your Would be required to create an User Model in the Models.dart folder
Your Pull request you only be accepted if your answer is compilling without any issues and solves the raised issue

Add routes in the main.dart file

The UI/UX design for the app is here
https://www.figma.com/proto/fg2pUtJ4oJmUfScwGD7oRo/CampusUs-Mobile-version?page-id=0%3A1&type=design&node-id=2-1718&viewport=646%2C313%2C0.12&t=tqwzJk8lSFjigPaY-1&scaling=scale-down&starting-point-node-id=2%3A1718&mode=design

Adding Routes
Add the following route by creating screens in the screen folder.The routes to be created are as follows.
Login
Signup
Request
Myrequests
MyProfile
About Us

Your Pull request you only be accepted if your answer is compilling without any issues and solves the raised issue

Adding an AppBar

The UI/UX design for the app is here
https://www.figma.com/proto/fg2pUtJ4oJmUfScwGD7oRo/CampusUs-Mobile-version?page-id=0%3A1&type=design&node-id=2-1718&viewport=646%2C313%2C0.12&t=tqwzJk8lSFjigPaY-1&scaling=scale-down&starting-point-node-id=2%3A1718&mode=design

Adding an AppBar
Add the AppBar according to the UI/UX design.

Adding a Drawer
Add the Drawer and add the components accroding to the UI/UX design

You can Enhance this feature by creating a util folder and making it a resuable component
Your Pull request you only be accepted if your answer is compilling without any issues and solves the raised issue

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.