now-u-app
Welcome! :wave:
This is the official repository for the now-u app. now-u is a non-profit started by James and Lizzie Elgar, aimed at driving positive change through coordinated monthly campaigns and actions. Volunteers from all over the world contributed to now-u, and are continuing to do so today, from app and web development, through designing and marketing. If you are reading this, there is a possibility you are a volunteer who has just been onboarded onto the team, and if this is the case, keep on reading! If not we appricate any contributions and are always looking for new members of the team so please don't hesitate to reach out.
If you want to learn more about now-u: Checkout our website https://now-u.com
Development :computer:
Whether you were formally onboarded onto the now-u team, or would like to contribute to some open source, now-u is extremely grateful for any input you may have, so firstly a massive THANK YOU! Although, if you are looking at contributing, please follow some code guidelines to ensure that this repository is kept clean for other contributors and volunteers.
- Pick an issue of your choosing from the
issuestab on this Github repository. If there is no-one assigned to an issue, ask @JElgar to assign you, or assign yourself and let us know on slack. - Once you get started set it as "in-progress" (you may have to assign it to the app project first)
- Make a branch (off
dev) called either "feature/description" or "bugfix/description" - Make the required changes
- Make a pr following the pr template
Setup :hammer:
Full setup guide - Getting Started
TLDR guide:
- Install flutter (and get a device setup)
- Clone the repo
- Run it -
flutter run
Where to start? :information_desk_person:
To find out what needs doing checkout the issues. Select an issue that looks interesting to you and double check its not been assigned/in-progress. Issues have priorities but the real priority is what you find interesting.
Testing
To generate mockito mocks run
flutter pub run build_runner build
Documentation :book:
For more detailed documentation checkout the wiki!
Adding custom icons
Get the icon as an SVG. Open it in inkscape Ctrl-a to select everything and object > Ungroup, Path > Stroke to Path and Path > Union. Save that and add the icon to https://www.fluttericon.com/
Libraries
- account_details_model
- AccountDetailsPage
- Action
- action_info_model
- ActionInfo
- analytics
- api_service
- article
- auth
- base_model
- Campaign
- campaign_info_model
- campaign_page
- campaign_view_model
- card
- Cause
- cause_indicator
- CauseOnboardingPage
- causes_service
- causes_view_model
- causeTile
- causeTileGrid
- ChangeCausePage
- ClipShadowPath
- ConfirmationModal
- constants
- custom_network_image
- customAppBar
- customIconButton
- customIcons
- Flutter icons MyFlutterApp Copyright (C) 2020 by original authors @ fluttericon.com, fontello.com This font was generated by FlutterIcon.com, which is derived from Fontello.
- customRoute
- customScrollableSheet
- customTile
- customWidthButton
- darkButton
- device_info_service
- dialog_manager
- dialog_service
- dialog_type
- dynamicLinks
- emailSentPage
- Explorable
- explore_page_view_model
- explore_tiles
- ExplorePage
- ExploreSection
- FAQ
- faq_model
- faq_service
- FAQPage
- firebase_options
- google_location_search_service
- header
- Home
- home_model
- InfoPage
- inputs
- internal_notification_service
- intro_view_model
- IntroPage
- Learning
- locator
- logger
- login
- login_code_view
- login_model
- main
- MoreMenu
- news_service
- Notification
- notification_model
- NotificationPage
- notifications
- Organisation
- organisation_service
- OrganisationPage
- organisationTile
- partners_model
- PartnersPage
- profile_setup
- profile_setup_view_model
- ProfileTile
- progressTile
- pushNotifications
- remote_config_service
- routes
- SDG
- search_service
- search_view_model
- searchBar
- SearchPage
- sectionTitle
- SplashScreen
- startup_model
- startup_view
- storage
- StyleFrom
- superbase
- Tabs
- tabs_view_model
- textButton
- User
- user_service
- utils