Merge pull request #124 from swciitg/Hacktoberfest_2023

Hacktoberfest 2023

CONTRIBUTING.md

@@ -0,0 +1,8 @@
+## Contribution Guide 🤠
+
+- Comment on the issue you are interested to work in and ask to be assigned
+- You have to strictly follow folder structure while working on issues [learn more](https://www.geeksforgeeks.org/flutter-file-structure/)
+- You will also have to strictly follow clean coding practices as mentioned [learn more](https://swciitg.notion.site/Basics-of-clean-code-1105189242954a4e9955eb8330872d46)
+- When creating pull request keep title as "issue title", example="submit button working" and description with issueID as "fixes #issueID"
+- If you find any bug or have new feature's idea then, create a issue with supporting description & details. If issue found relevant then, maintainers will react to it and you can start working on it
+

README.md

@@ -1 +1,67 @@
-![feature graphic](https://user-images.githubusercontent.com/75874394/192554328-370aece6-9697-4878-92b8-eb120d07e1b1.png)
+<br />
+<p align="center"><img src="https://user-images.githubusercontent.com/75874394/192554328-370aece6-9697-4878-92b8-eb120d07e1b1.png"></p>
+
+# OneStop : IIT Guwahati campus application
+#### OneStop is developed wih motivation of assisting IIT Guwahati students in daily life utilities like Academic timetable, Food menus, Bus/Ferry timings and more. Students' Web Committee took the lead for this product, involved in its development from ideation, user research to deployment and release.
+
+
+## Download Links
+#### [Follow for PlayStore](https://play.google.com/store/apps/details?id=com.swciitg.onestop2) || [Follow for AppStore](https://apps.apple.com/in/app/onestop-iitg/id1642792642)
+
+## 🧩 Main Features
+<li>Bus/Ferry schedule</li>
+<li>Lost/Found items reporting</li>
+<li>Buy/Sell items listing service</li>
+<li>Contacts to vital administrative sections.</li>
+<li>Cab sharing to share cab expenses</li>
+<li>Food outlets and hostel messes updated menu</li>
+<li>Separate categories under Buy & Sell</li>
+<li>Dynamic scoreboard for Inter-hostel competitions</li>
+<li>Mobile notifications for multiple services</li>
+
+## 💻 TechStack Used
+
+<li>Flutter</li>
+<li>Dart</li>
+<li>Firebase - Cloud messaging</li>
+
+## How would you like to contribute to this Project?
+<li>Design files for all the Task has been attached with Github Issues.</li>
+<li>Create a Developers Page for the app.</li>
+<li>Create a Page for taking Mess performance reviews from the user.</li>
+<li>Create a Page for changing Mess Subscription from one Hostel to another.</li>
+<li>Display Time-Table on the app.</li>
+<li>Create a Readme for this Repository</li>
+
+## Setting up project on your machine ⚙️
+- [Follow this guide](https://swciitg.notion.site/Day-1-f6ea19b1d7ff410e8ec03683772f4cd0) to setup Android Studio & Flutter SDK on your machine
+- [Follow this to setup Firebase project](https://www.youtube.com/watch?v=sz4slPFwEvs) for your project in the app also, enable email-password authentication, initialize cloud firestore database in your firebase project
+- Fork this repository, Clone the forked repository on your machine and start working on issues
+- If you are new to Flutter checkout these [learning resources](https://swciitg.notion.site/8eb17b6e8f034d7cbd04f98054640cd0?v=50726fa13f6d40c1882448900ee36b03) from workshop conducted by SWC IIT Guwahati
+
+## Running app on your Machine
+- OneStop require run [Arguments](runargs) to be included for running the App
+- Open Android Studio and your Flutter application.
+  Open the "Edit Run/Debug Configurations" dialog.
+  In the "Additional Arguments" field, add the desired arguments.
+  Save the changes.
+  Run your program from the "Run Menu".Refer to the screenshot for better understanding.
+
+## Contribution Guide 🤠
+Before contributing be sure to check out the [CONTRIBUTION](CONTRIBUTING.md) guidelines.
+
+## Help & Discussions 🙌
+
+- Go to discussions section of this repository to start new discussion or look at previous discussions.
+- Join SWC IIT Guwahati's [Discord Server](https://discord.gg/2QUrA8HgWx) for accessing great learning resources, connecting with awesome community
+
+## Join us on social media
+
+[Discord](https://discord.gg/djNKYdge2a) | [Facebook](https://www.facebook.com/swciitg/) | [LinkedIn](https://www.linkedin.com/company/student-s-web-committee-iitg/mycompany/)
+# 🐛 Bug Reporting
+#### Feel free to [open an issue](https://github.com/swciitg/one-stop-2021/issues) on GitHub if you find any bug.
+
+<br />
+
+# ⭐ Feature Suggestion
+#### Feel free to [open an issue](https://github.com/swciitg/one-stop-2021/issues) on GitHub if you have feature idea to be added 🙌.

runargs

@@ -0,0 +1 @@
+--dart-define SERVER-URL="https://swc.iitg.ac.in/test/onestop/api/v3" --dart-define SECURITY-KEY="OneStop-Test" --dart-define GMAP_KEY="gmapkey" --dart-define GITHUB_ISSUE_TOKEN="X" --dart-define IRBS-SERVER-URL="https://swc.iitg.ac.in/test/irbs"