anitab-org / mentorship-flutter

THIS PROJECT IS ARCHIVED. Mentorship System is an application that matches women in tech to mentor each other, on career development, through 1:1 relations during a certain period of time. This is the Flutter version of this project.

Cross-platform client for Mentorship System

Branch	Travis
develop

Mentorship System is an application that allows women in tech to mentor each other, on career development topics, through 1:1 relations for a certain period of time.

This is the client app for the Mentorship System backend. It's written in the Flutter framework.

Work in progress

Purpose

AnitaB.org aims to be as inclusive as possible for everyone. It should apply to user's mobile operating system, too :) That's why we decided to use Flutter to deliver a high-quality app for everybody – Android, iOS, and web users.

From the technical point of view, having one codebase for all platforms will make adding new featuresand bug fixes much faster.

Contributing

Please read our Contributing guidelines, Code of Conduct and Reporting Guidelines.

If you have any questions or simply want to interact with our community, come and join us at out AnitaB.org Open Source Zulip. We have a dedicated stream for this project #mentorship-system.

Overview

• App tries to follow Clean Architecture guidelines. Logic is separated into 4 layers:
  • UI
  • BLoC
  • Repository
  • Service
• App uses BLoC pattern extensively
• To communicate with the API, Chopper is used
• To save JWT token, Flutter Secure Storage is used
• If you find something in code that looks a bit odd, it might be some useful extension method from lib/extensions

Setup Instructions

In order to setup the project locally, setup instructions have been defined here

Web support

Flutter for Web is currently at technical preview stage. To test this functionality, I created a separate branch. I successfully ran this app in Chrome.

web example here

It's neither stable nor works smoothly (yet), but hey, it works.

Unfortunately I was unable to make requests to the hosted dev server because apparently it has CORS disabled. Fortunately, it is at least possible to connect to the server running on localhost :)

To use web version of this app with your local server:

1. Make these small changes to your local webserver to enable CORS
2. Run local server

Contact us

Feel free to reach out to the maintainers and our community on AnitaB.org Open Source Zulip. If you are interested in participating in discussions related to this project, we have a dedicated stream for this project #mentorship-system, where you can ask your doubts and interact with our community.