MyMGS

An MGS School Council project.

Important: before making a contribution

Before making a contribution, please read the contributing guide and follow it.

About this project

We're making an app to help MGS students navigate school life. This app will eventually include a range of features:

• A list of clubs, talks, societies, and drama performances
• Up-to-date catering menu — and a quick way to see what today's menu is
• Links to well-being charities
• Practical revision resources, sorted by year group and subject
• ...and more!

Getting started

To get started developing MyMGS, take a look at Pal's slideshow which contains some handy tips on how to install the Flutter SDK and set up your environment.

Then, clone this repo. If you're on Mac or Linux, Git should already be installed, but on Windows you'll need to install it yourself. Once that's done, just open a command line, navigate to your intended parent directory, and run:

git clone https://github.com/My-MGS/my-mgs mymgs

Enter the directory with your command line, and run:

flutter pub get
./protoc.sh # compiles Protocol Buffer files into Dart source

And you're done! Open Android Studio (or your preferred IDE, but Android Studio definitely gives the best experience) and open the new mymgs directory.