Skip to content

Latest commit

 

History

History
167 lines (120 loc) · 7.08 KB

README.md

File metadata and controls

167 lines (120 loc) · 7.08 KB
Raw

Monday Morning Logo

Monday Morning

The Official Student Media Body of NIT Rourkela

View Live • View Issues • Report Bugs • Suggest Features

Project Overview

Project License Project Contributers Project Forks Project Stargazers

Table of Contents
  1. About Monday Morning
  2. About the Project
  3. Built With
  4. Getting Started
  5. License

About Monday Morning

Monday Morning

Monday Morning is the student media body of National Institute of Technology, Rourkela. Since its inception in 2006, it has constantly served as a vital link between the student community and the administration. The weekly e-newsletter serves as a news feed for the students, professors and alumni of the institute, featuring campus activities, department updates, recruitment information, SAC happenings, alumni news, weekly polls and interviews of the Director, Chief Warden, professors, distinguished alumni and dignitaries and exceptional students. Apart from the online weekly edition, Monday Morning also publishes print editions and organises the Open House Discussion.

About the Project

Project Infinity is about updating the Monday Morning website using modern technologies which is divided accross 3 main sub-projects.

  1. project-tahiti: The Client side application of the website.
  2. project-reclamation: The Server application of the website.
  3. project-pegasus: The cross-platform Mobile application of the Monday Morning.

Built With

Following technologies and libraries are used for the development of this website

Getting Started

To setup the project locally follow the steps below.

Contribution guidlines 🎃

NOTE 1: Please abide by the Contributing Guidelines.

NOTE 2: Please abide by the Code of Conduct.

Local Repository Setup

Please refer to the project's style and contribution guidelines for submitting patches and additions. In general, we follow the "fork-and-pull" Git workflow.

  1. Fork the repo on GitHub
  2. Clone the project to your local system
  3. Commit changes to your own separate branch
  4. Push your work back up to your fork
  5. Submit a Pull request so that we can review your changes

Running the project.

  1. Install Flutter on your machine

    Install flutter by selecting the operating system on which you are installing Flutter: Flutter installation tutorial

    To check if you have flutter installed along wtih proper necesarry SDKs installed run flutter doctor

  2. Fork and Clone the Repo

    Fork the repo by clicking on the Fork button on the top right corner of the page. To clone this repository, run git clone https://github.com/Monday-Morning/project-pegasus.git Then run cd app

  3. Get Packages

    Make sure you are in the project-pegasus/app directory

    • From the terminal: Run flutter pub get. OR
    • From Android Studio/IntelliJ: Click Packages get in the action ribbon at the top of pubspec.yaml.
    • From VS Code: Click Get Packages located in right side of the action ribbon at the top of pubspec.yaml.

  4. Configure

    Make sure you are in the project-pegasus/app directory

    • Activate FlutterFire by running dart pub global activate flutterfire_cli.
    • Configure the project by running dart pub global run flutterfire_cli:flutterfire configure.
    • You can use firebase emulator to run the project.

  5. Build

    To build the project run flutter pub run build_runner build.

Run the App

On terminal:

  • Check that an Android device is running by running flutter devices. If none are shown, follow the device-specific instructions on the Install page for your OS.
  • Run the app with the following command: flutter run .

License

Distributed under the MIT License. See License for more information.