Skip to content

Latest commit

 

History

History
114 lines (85 loc) · 4.92 KB

README.md

File metadata and controls

114 lines (85 loc) · 4.92 KB
Raw

Logo

ClickBoard

Streamlining your academic experience.

Explore the docs »

View Demo . Report Bug . Request Feature

Downloads Contributors Stargazers Issues License

Table Of Contents

About The Project

Clickboard is a powerful Flutter app, seamlessly integrated with Firebase, designed to streamline your academic experience. It offers a range of features including secure authentication, intuitive carousel navigation, term-specific notices, roll number-based academic results, engaging Lottie animations, and convenient account management options like password reset, updates, and deactivation. Simplify your academic journey with Clickboard.

Built With

  • Flutter
  • Firebase : As a BaaS for this project
  • Riverpod : As a state management tool
  • Go router : For routing between pages

Getting Started

This is how you may set up your project locally. To get a local copy up and running follow these simple steps.

Prerequisites

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

Installation

  1. Create a flutter project
flutter create app-name
  1. Clone the repo
git clone https://github.com/Abhigyan103/Clickboard.git
  1. Install pub modules
pub get
  1. Configure firebase database

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

Contributing

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

  • If you have suggestions for adding or removing projects, feel free to open an issue to discuss it, or directly create a pull request after you edit the README.md file with necessary changes.
  • Please make sure you check your spelling and grammar.
  • Create individual PR for each suggestion.
  • Please also read through the Code Of Conduct before posting your first idea as well.

Creating A Pull Request

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feat/AmazingFeature) or Bug Fix Feature (git checkout -b fix/BugName)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature' or git commit -m 'Fixes #issueNumber)
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request to main

Authors