Skip to content
This repository has been archived by the owner on Feb 11, 2025. It is now read-only.

Commit

Permalink
fix: convention and performance (#19)
Browse files Browse the repository at this point in the history
* 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
abhigyantrips authored Mar 3, 2024
1 parent d6bcb19 commit aa58dc9
Show file tree
Hide file tree
Showing 80 changed files with 444 additions and 660 deletions.
29 changes: 7 additions & 22 deletions .metadata
Original file line number Diff line number Diff line change
@@ -1,38 +1,23 @@
# This file tracks properties of this Flutter project.
# Used by Flutter tool to assess capabilities and perform upgrades etc.
#
# This file should be version controlled.
# This file should be version controlled and should not be manually edited.

version:
revision: 135454af32477f815a7525073027a3ff9eff1bfd
channel: stable
revision: "7482962148e8d758338d8a28f589f317e1e42ba4"
channel: "stable"

project_type: app

# Tracks metadata for the flutter migrate command
migration:
platforms:
- platform: root
create_revision: 135454af32477f815a7525073027a3ff9eff1bfd
base_revision: 135454af32477f815a7525073027a3ff9eff1bfd
create_revision: 7482962148e8d758338d8a28f589f317e1e42ba4
base_revision: 7482962148e8d758338d8a28f589f317e1e42ba4
- platform: android
create_revision: 135454af32477f815a7525073027a3ff9eff1bfd
base_revision: 135454af32477f815a7525073027a3ff9eff1bfd
- platform: ios
create_revision: 135454af32477f815a7525073027a3ff9eff1bfd
base_revision: 135454af32477f815a7525073027a3ff9eff1bfd
- platform: linux
create_revision: 135454af32477f815a7525073027a3ff9eff1bfd
base_revision: 135454af32477f815a7525073027a3ff9eff1bfd
- platform: macos
create_revision: 135454af32477f815a7525073027a3ff9eff1bfd
base_revision: 135454af32477f815a7525073027a3ff9eff1bfd
- platform: web
create_revision: 135454af32477f815a7525073027a3ff9eff1bfd
base_revision: 135454af32477f815a7525073027a3ff9eff1bfd
- platform: windows
create_revision: 135454af32477f815a7525073027a3ff9eff1bfd
base_revision: 135454af32477f815a7525073027a3ff9eff1bfd
create_revision: 7482962148e8d758338d8a28f589f317e1e42ba4
base_revision: 7482962148e8d758338d8a28f589f317e1e42ba4

# User provided section

Expand Down
196 changes: 98 additions & 98 deletions README.md
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.
55 changes: 21 additions & 34 deletions android/app/build.gradle
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
plugins {
id "com.android.application"
id "kotlin-android"
id "dev.flutter.flutter-gradle-plugin"
}

def localProperties = new Properties()
def localPropertiesFile = rootProject.file('local.properties')
if (localPropertiesFile.exists()) {
Expand All @@ -6,11 +12,6 @@ if (localPropertiesFile.exists()) {
}
}

def flutterRoot = localProperties.getProperty('flutter.sdk')
if (flutterRoot == null) {
throw new GradleException("Flutter SDK not found. Define location with flutter.sdk in the local.properties file.")
}

def flutterVersionCode = localProperties.getProperty('flutter.versionCode')
if (flutterVersionCode == null) {
flutterVersionCode = '1'
Expand All @@ -21,16 +22,9 @@ if (flutterVersionName == null) {
flutterVersionName = '1.0'
}

apply plugin: 'com.android.application'
apply plugin: 'kotlin-android'
apply from: "$flutterRoot/packages/flutter_tools/gradle/flutter.gradle"
def keystoreProperties = new Properties()
def keystorePropertiesFile = rootProject.file('key.properties')
if (keystorePropertiesFile.exists()) {
keystoreProperties.load(new FileInputStream(keystorePropertiesFile))
}
android {
compileSdkVersion 33
namespace "com.example.noticeboard"
compileSdk flutter.compileSdkVersion
ndkVersion flutter.ndkVersion

compileOptions {
Expand All @@ -48,33 +42,26 @@ android {

defaultConfig {
// TODO: Specify your own unique Application ID (https://developer.android.com/studio/build/application-id.html).
applicationId "com.codexmitb.maheblr_noticeboard"
applicationId "com.example.noticeboard"
// You can update the following values to match your application needs.
// For more information, see: https://docs.flutter.dev/deployment/android#reviewing-the-build-configuration.
minSdkVersion 29
targetSdkVersion 31
// For more information, see: https://docs.flutter.dev/deployment/android#reviewing-the-gradle-build-configuration.
minSdkVersion flutter.minSdkVersion
targetSdkVersion flutter.targetSdkVersion
versionCode flutterVersionCode.toInteger()
versionName flutterVersionName
}
signingConfigs {
release {
keyAlias keystoreProperties['keyAlias']
keyPassword keystoreProperties['keyPassword']
storeFile keystoreProperties['storeFile'] ? file(keystoreProperties['storeFile']) : null
storePassword keystoreProperties['storePassword']
}
}
buildTypes {
release {
signingConfig signingConfigs.release
}
}

buildTypes {
release {
// TODO: Add your own signing config for the release build.
// Signing with the debug keys for now, so `flutter run --release` works.
signingConfig signingConfigs.debug
}
}
}

flutter {
source '../..'
}

dependencies {
implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
}
dependencies {}
3 changes: 1 addition & 2 deletions android/app/src/debug/AndroidManifest.xml
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
<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.
Expand Down
19 changes: 14 additions & 5 deletions android/app/src/main/AndroidManifest.xml
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
package="com.example.notice_board">
<uses-permission android:name="android.permission.INTERNET"/>
<application
android:label="MAHE BLR Notice Board"
<manifest xmlns:android="http://schemas.android.com/apk/res/android">
<application
android:label="noticeboard"
android:name="${applicationName}"
android:icon="@mipmap/launcher_icon">
<activity
Expand Down Expand Up @@ -32,4 +30,15 @@
android:name="flutterEmbedding"
android:value="2" />
</application>
<!-- Required to query activities that can process text, see:
https://developer.android.com/training/package-visibility?hl=en and
https://developer.android.com/reference/android/content/Intent#ACTION_PROCESS_TEXT.
In particular, this is used by the Flutter engine in io.flutter.plugin.text.ProcessTextPlugin. -->
<queries>
<intent>
<action android:name="android.intent.action.PROCESS_TEXT"/>
<data android:mimeType="text/plain"/>
</intent>
</queries>
</manifest>

This file was deleted.

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()
Binary file modified android/app/src/main/res/mipmap-hdpi/launcher_icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified android/app/src/main/res/mipmap-mdpi/launcher_icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified android/app/src/main/res/mipmap-xhdpi/launcher_icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified android/app/src/main/res/mipmap-xxhdpi/launcher_icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified android/app/src/main/res/mipmap-xxxhdpi/launcher_icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 1 addition & 3 deletions android/app/src/profile/AndroidManifest.xml
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>
Loading

0 comments on commit aa58dc9

Please sign in to comment.