NoticeBoard is a Flutter-based open-source project that provides a platform for displaying and managing notices. It aims to make it easy for organizations and communities to share important information with their members.
These instructions will get you a copy of the NoticeBoard project up and running on your local machine for development and testing purposes.
Before getting started, make sure you have the following installed on your system:
- Flutter SDK (version X.X.X): Flutter Installation Guide
- Dart SDK (version X.X.X): Dart Installation Guide
- Clone the NoticeBoard repository:
git clone https://github.com/mitblr-club/noticeboard.git- Navigate to the project directory:
cd noticeboard- Install the project dependencies:
flutter pub getTo run the NoticeBoard project on your local machine, follow these steps:
Ensure you have a connected device (emulator or physical device) or a running simulator.
- Run the application:
flutter runThis command will build and launch the NoticeBoard application on your device.
Any idea on how we can make this more awesome ? Open a new issue! We need all the help we can get to make this project awesome! You can also join the discord server to give suggestions. You can read the Contributing guidelines.
If you want to contribute code to the project, you can do so by submitting a pull request. Here's how:
- Fork the repository to your GitHub account.
- Clone your forked repository to your local machine.
git clone https://github.com/mitblr-club/noticeboard - Create a new branch for your changes:
git checkout -b my-feature - Make the necessary changes and commit them.
git add .git commit -m "commit message" - Push your changes to your forked repository:
git push origin my-feature
- Open a pull request on the Pull Request page of the original repository.
The NoticeBoard project is licensed under the GPL-3.0 License. Please see the LICENSE.md file for more details.