Skip to content

Latest commit

 

History

History
64 lines (39 loc) · 3.31 KB

README.md

File metadata and controls

64 lines (39 loc) · 3.31 KB
Raw

now-u-app

Welcome! 👋

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 💻

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.

  1. Pick an issue of your choosing from the issues tab 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.
  2. Once you get started set it as "in-progress" (you may have to assign it to the app project first)
  3. Make a branch (off dev) called either "feature/description" or "bugfix/description"
  4. Make the required changes
  5. Make a pr following the pr template

Setup 🔨

Full setup guide - Getting Started

TLDR guide:

  1. Install flutter (and get a device setup)
  2. Clone the repo
  3. Generate openapi client - cd openapi && make generate-prod
  4. Run build runner - flutter pub run build_runner build --delete-conflicting-outputs
  5. Run it - flutter run

Where to start? 💁

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.

Formatting

During code review CI both dart analyzer and dart format are run. These checks can be run locally (with auto fix) with the command make format. (NOTE: make is a prerequisite - for the windows users among us see: https://stackoverflow.com/a/32127632/13473952)

Testing

To generate mockito mocks run

flutter pub run build_runner build

Debugging analytics

To debug analytics run the app in debug mode and run the following command

adb shell setprop debug.firebase.analytics.app com.nowu.app

then visit https://analytics.google.com/analytics/web/#/a164779666p230669081/admin/debugview/overview

Documentation 📖

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/