Skip to content

Latest commit

 

History

History
158 lines (107 loc) · 5.91 KB

README.md

File metadata and controls

158 lines (107 loc) · 5.91 KB
Raw

DU-HACKS MOBILE APP 📱

Welcome to the DU-Hacks mobile app repository! This Flutter-based app is designed to streamline the process of registrations, check-ins, and communication during the DU-Hacks hackathon. Whether you're a participant, organizer, or volunteer, this app will enhance your DU-Hacks experience.

License: MIT discord


🌟 Stars 🍴 Forks 🐛 Issues 🔔 Open PRs 🔕 Close PRs
Stars Forks Issues Open Pull Requests Close Pull Requests

Pushpin Tech Stacks!

flutter nodejs


Features of DU-HACKS Mobile App :

  • Check-In: Swift and convenient check-in process for participants can be made possible for hackathons as well as different events.
  • Glimpse of previous DU-HACKS: One can get the info about previous DU-Hack Hackathons.
  • Communication: Stay updated with event announcements through notifications.
  • Schedule: Access the event schedule and set reminders for your favorite sessions.
  • View Sponsors: Access the info about the sponsors for the current DU-HACKS hackathon.
  • Know about winning prizes: Can swiftly check the prizes as soon as they are updated and changes and info about different prize winning tracks.
  • Know about Themes: Access the themes for the current DU-Hacks.
  • Team Formation: Find and connect with potential team members for hackathon projects.

Guidelines For Setting up this flutter app in your local machine :

Getting Started

Follow these steps to get the DU-Hacks mobile app up and running on your local environment.

Prerequisites

  • Flutter must be installed on your development machine.
  • An Android emulator or physical Android device for Android development.
  • An iOS simulator or physical iOS device for iOS development (Mac only).

Installation

  1. Clone the repository:

    git clone https://github.com/developer-student-clubs/DU-Hacks-Mobile-App.git

  2. Navigate to the project directory:

    cd DU-Hacks-Mobile-App

  3. Install the app's dependencies:

    flutter pub get

  4. Launch the app on your preferred device or emulator:

    For Android:

    flutter run

    For iOS:

    flutter run

Contributing

We welcome contributions to enhance the DU-Hacks mobile app. If you'd like to contribute, please follow these guidelines:

  1. Fork the repository and create a new branch for issue assigned to you or new feature or bug fix.
  2. Make your changes and thoroughly test them.
  3. Create a pull request with a clear description of your changes.

For functionality implementation ( Issues related to schedule, prize, sponsors etc) :

  1. For functionality implementation issues you will need to fetch the data from the given API endpoints.

    -> Get Whole Schedule : https://du-hacks-apis.vercel.app/api/v2/schedule
    -> Get particular schedule info : https://du-hacks-apis.vercel.app/api/v2/schedule/6510007a8db0f502f5502435
    -> Get prize pool info : https://du-hacks-apis.vercel.app/api/v2/prizes/
    -> Get particular prize : https://du-hacks-apis.vercel.app/api/v2/prizes/6510087f5c864eaf758e96b2
    -> Get Sponsors Details : https://du-hacks-apis.vercel.app/api/v2/sponsors
    -> Get Info related to themes : https://du-hacks-apis.vercel.app/api/v2/theme

  2. For Detailed Doucmentaion of this API refer to this : API Endpoint Documentation

Please review our Contribution Guidelines for more details.

License

This project is licensed under the MIT License.

Maintainers :

Dwijsinh H Gohil - https://github.com/dwijgohil24
Om Dhingani - https://github.com/om1512
Vivek Patel - https://github.com/vivek201102

Contributors :

Contributors


Show some Love by starring this repo ! 💙

If you have any questions, encounter issues, or want to contribute, please don't hesitate to get in touch with us. Happy hacking!