Thinking of contributing to BLT-Flutter's mobile app? Here's a comprehensive guide to let you join in the fun of the open source world!
To be able to contribute to the BLT-Flutter app, you must understand the project, BLT first. To iterate the basics, BLT is a bug logging tool which enables the users (i.e., one of you!) to share the common bugs you find while you surf over the hundreds of different websites or apps. This knowledge of the presence of a bug enables the developers to fix them quickly and thus enhance your browsing experience on that website or that app. This is not the end, you also get rewarded for finding bugs and can also get rewarded in case you are on the top leaderboards of a bug hunt organized by various companies on BLT!
Open Source FTW!
All of the BLT-Flutter app's code is in this repository.
To keep things mantainabale, the website's frontend, backend, and the API's code is in The BLT repository.
Too much talkin', let's get to the business, yes? We welcome both developers and designers, so we have something for both of you!
Follow the steps below, and you'll be able to set up the dev environment in no time!
- Go to the OWASP/BLT-Flutter repository.
- Clone the repository, run
git clone https://github.com/OWASP/BLT-Flutter(you can use any way of your choice). - Open the project in an editor of your choice, and then run
flutter runfrom the current working directory. (Haven't installed flutter? or are new to flutter?)
If you were able to build the app, then you're all set! Check the next section on what to do next.
We value a good user experience empowered by good design practices. You can view the current UI mockups implemented for the app in the below attached Figma file. You can submit your suggestions here on discussions; if your suggestions are ideal, we'll add them to the design file.
Figma link: https://www.figma.com/file/NYD5WZzJywnO338lchnece/BLT?node-id=7%3A634&t=gjDWzr6qy82jpUQa-1
If you have set up the dev environment, what are you waiting for? You can do so much! Need a good starting point? Go through the list of issues on the repository! Have a great new idea that you implemented and want it in the app? Make a PR, and we'll be sure to consider it! One last thing, while suggesting a screen, please follow the design schemes in the above-shared design file, and make sure that flutter analyze works before submitting that hard-worked pull request of yours!