This repository has been archived by the owner on Feb 11, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix: convention and performance (#19)
* chore: update filenames to underscore style * fix: rename more files, remove tests * fix: performance issues with const * feat: add new launcher icon * chore: branding migration to mitblr.club * feat: update package name, gradle wrapper * fix: add new institute asset
- Loading branch information
1 parent
d6bcb19
commit aa58dc9
Showing
80 changed files
with
444 additions
and
660 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,98 +1,98 @@ | ||
# NoticeBoard 📝 | ||
|
||
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. | ||
|
||
## Table of Contents | ||
|
||
- [Getting Started](#getting-started) | ||
- [Prerequisites](#prerequisites) | ||
- [Installation](#installation) | ||
- [Usage](#usage) | ||
- [Contributing](#contributing) | ||
- [Submitting Pull Requests](#submitting-pull-requests) | ||
- [License](#license) | ||
|
||
## Getting Started | ||
|
||
These instructions will get you a copy of the NoticeBoard project up and running on your local machine for development and testing purposes. | ||
|
||
### Prerequisites | ||
|
||
Before getting started, make sure you have the following installed on your system: | ||
|
||
- Flutter SDK (version X.X.X): [Flutter Installation Guide](https://flutter.dev/docs/get-started/install) | ||
- Dart SDK (version X.X.X): [Dart Installation Guide](https://dart.dev/get-dart) | ||
|
||
### Installation | ||
|
||
1. Clone the NoticeBoard repository: | ||
|
||
```bash | ||
git clone https://github.com/CodeX-MIT-BLR/NoticeBoard.git | ||
``` | ||
2. Navigate to the project directory: | ||
|
||
```bash | ||
cd NoticeBoard | ||
``` | ||
3. Install the project dependencies: | ||
|
||
```bash | ||
flutter pub get | ||
``` | ||
### Usage | ||
|
||
To 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. | ||
|
||
1. Run the application: | ||
```bash | ||
flutter run | ||
``` | ||
This command will build and launch the NoticeBoard application on your device. | ||
|
||
<img src="https://raw.githubusercontent.com/HurricanoBot/HurricanoImages/d0facab8f7e20042e5f1381525d6a80ada6e62e6/other/undraw_real_time_collaboration_c62i.svg" width="50%" align="right"> | ||
<h2>Contributing</h2> | ||
|
||
Any idea on how we can make this more awesome ? [Open a new issue](https://github.com/CodeX-MIT-BLR/NoticeBoard/issues)! 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](CONTRIBUTING.md). | ||
|
||
<br/> | ||
<br/> | ||
<br/> | ||
<br/> | ||
<br/> | ||
<br/> | ||
|
||
## Submitting Pull Requests | ||
|
||
If you want to contribute code to the project, you can do so by submitting a pull request. Here's how: | ||
|
||
1. Fork the repository to your GitHub account. | ||
2. Clone your forked repository to your local machine. | ||
```git clone https://github.com/CodeX-MIT-BLR/NoticeBoard``` | ||
3. Create a new branch for your changes: | ||
```git checkout -b my-feature``` | ||
4. Make the necessary changes and commit them. | ||
```git add .``` | ||
```git commit -m "commit message"``` | ||
5. Push your changes to your forked repository: | ||
``` | ||
git push origin my-feature | ||
``` | ||
6. Open a pull request on the Pull Request page of the original repository. | ||
|
||
## Project Maintainers ✨ | ||
|
||
<table> | ||
<tr> | ||
<td align="center"><a href="https://github.com/Chandan-CV"><img src="https://avatars.githubusercontent.com/u/37525954?v=4" width="100px;" alt=""/><br /><sub><b>Chandan-CV | ||
</b></sub></a></td> | ||
<td align="center"><a href="https://github.com/scenario7"><img src="https://avatars.githubusercontent.com/u/77824686?v=4" width="100px;" alt=""/><br /><sub><b>Kevin Thomas | ||
</b></sub></a></td> | ||
</tr> | ||
</table> | ||
|
||
## License | ||
|
||
The NoticeBoard project is licensed under the MIT License. Please see the LICENSE file for more details. | ||
# NoticeBoard 📝 | ||
|
||
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. | ||
|
||
## Table of Contents | ||
|
||
- [Getting Started](#getting-started) | ||
- [Prerequisites](#prerequisites) | ||
- [Installation](#installation) | ||
- [Usage](#usage) | ||
- [Contributing](#contributing) | ||
- [Submitting Pull Requests](#submitting-pull-requests) | ||
- [License](#license) | ||
|
||
## Getting Started | ||
|
||
These instructions will get you a copy of the NoticeBoard project up and running on your local machine for development and testing purposes. | ||
|
||
### Prerequisites | ||
|
||
Before getting started, make sure you have the following installed on your system: | ||
|
||
- Flutter SDK (version X.X.X): [Flutter Installation Guide](https://flutter.dev/docs/get-started/install) | ||
- Dart SDK (version X.X.X): [Dart Installation Guide](https://dart.dev/get-dart) | ||
|
||
### Installation | ||
|
||
1. Clone the NoticeBoard repository: | ||
|
||
```bash | ||
git clone https://github.com/mitblr-club/noticeboard.git | ||
``` | ||
2. Navigate to the project directory: | ||
|
||
```bash | ||
cd NoticeBoard | ||
``` | ||
3. Install the project dependencies: | ||
|
||
```bash | ||
flutter pub get | ||
``` | ||
### Usage | ||
|
||
To 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. | ||
|
||
1. Run the application: | ||
```bash | ||
flutter run | ||
``` | ||
This command will build and launch the NoticeBoard application on your device. | ||
|
||
<img src="https://raw.githubusercontent.com/HurricanoBot/HurricanoImages/d0facab8f7e20042e5f1381525d6a80ada6e62e6/other/undraw_real_time_collaboration_c62i.svg" width="50%" align="right"> | ||
<h2>Contributing</h2> | ||
|
||
Any idea on how we can make this more awesome ? [Open a new issue](https://github.com/mitblr-club/noticeboard/issues)! 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](CONTRIBUTING.md). | ||
|
||
<br/> | ||
<br/> | ||
<br/> | ||
<br/> | ||
<br/> | ||
<br/> | ||
|
||
## Submitting Pull Requests | ||
|
||
If you want to contribute code to the project, you can do so by submitting a pull request. Here's how: | ||
|
||
1. Fork the repository to your GitHub account. | ||
2. Clone your forked repository to your local machine. | ||
```git clone https://github.com/mitblr-club/noticeboard``` | ||
3. Create a new branch for your changes: | ||
```git checkout -b my-feature``` | ||
4. Make the necessary changes and commit them. | ||
```git add .``` | ||
```git commit -m "commit message"``` | ||
5. Push your changes to your forked repository: | ||
``` | ||
git push origin my-feature | ||
``` | ||
6. Open a pull request on the Pull Request page of the original repository. | ||
|
||
## Project Maintainers ✨ | ||
|
||
<table> | ||
<tr> | ||
<td align="center"><a href="https://github.com/Chandan-CV"><img src="https://avatars.githubusercontent.com/u/37525954?v=4" width="100px;" alt=""/><br /><sub><b>Chandan-CV | ||
</b></sub></a></td> | ||
<td align="center"><a href="https://github.com/scenario7"><img src="https://avatars.githubusercontent.com/u/77824686?v=4" width="100px;" alt=""/><br /><sub><b>Kevin Thomas | ||
</b></sub></a></td> | ||
</tr> | ||
</table> | ||
|
||
## License | ||
|
||
The NoticeBoard project is licensed under the MIT License. Please see the LICENSE file for more details. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 changes: 0 additions & 6 deletions
6
android/app/src/main/kotlin/com/example/notice_board/MainActivity.kt
This file was deleted.
Oops, something went wrong.
5 changes: 5 additions & 0 deletions
5
android/app/src/main/kotlin/com/example/noticeboard/MainActivity.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
package com.example.noticeboard | ||
|
||
import io.flutter.embedding.android.FlutterActivity | ||
|
||
class MainActivity: FlutterActivity() |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,7 @@ | ||
<manifest xmlns:android="http://schemas.android.com/apk/res/android" | ||
package="com.example.notice_board"> | ||
<manifest xmlns:android="http://schemas.android.com/apk/res/android"> | ||
<!-- The INTERNET permission is required for development. Specifically, | ||
the Flutter tool needs it to communicate with the running application | ||
to allow setting breakpoints, to provide hot reload, etc. | ||
--> | ||
<uses-permission android:name="android.permission.INTERNET"/> | ||
<uses-permission android:name="android.permission.VIBRATE" /> | ||
</manifest> |
Oops, something went wrong.