The Optimum Project

The FTC Team Scouter App that gets you results!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact

About The Project

The FTC Team Scouter App that gets you results! Find your perfect alliance by seeing on what their robot can do, and find contact details all from right in the app! Great UI interfaces, Animations and more make it the perfect app for you.

This project is developed using a Dart framework developed by Google called Flutter.

Flutter is an open-source UI software development kit created by Google. It is used to develop cross platform applications for Android, iOS, Linux, Mac, Windows, Google Fuchsia, Web platform, and the web from a single codebase. - Google Knowledge Panel

(back to top)

Built With

• Flutter
• Firebase

(back to top)

Install

You can install using the App Store or the Play Store. Alternativly, you can install directly by using a published GitHub Release APK file (Android only).

Prerequisites for Contribution

This is an example of how to list things you need to use the software and how to install them.

• flutter

  flutter doctor
  flutter pub get

Installation for Development

1. Create a free Firebase account and get your own database to test with
2. Clone the repo

   git clone https://github.com/kidsonfilms-python-rules/Optimum.git

3. Install Flutter packages

   flutter pub get

4. Follow and upload and files Firebase wants you to when adding a new device to your project

(back to top)

Roadmap

• Basic Release
• Streamline UI in places such as Sign-in and Competition finder
• Add fellow-team endorsements to self-reported strengths

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the GPL-2.0 License. See LICENSE.txt for more information.

(back to top)

About Juice 16236

Juice 16236 is a FTC team based in NorCal founded in 2018. We are a team of high school seniors and 8th graders.

(back to top)