GirlScript App – A boilerplate for any technical community

Flutterappworld

4 years ago

About

A boilerplate for any technical community to pick up and use for their own without any hassle This app is a center to various events ranging from portraying the member’s achievements to announcing the upcoming opportunities. Additionally, this app developed by the community, and for the community, will add elegance. Plus, being open-source.

GirlScript App

This app is a center to various events ranging from portraying the member’s achievements to announcing the upcoming opportunities. Additionally, this app developed by the community, and for the community, will add elegance. Plus, being as an open source project, this will be a golden opportunity for beginners to learn and contribute to it just like a cherry on the cake.

Prerequisites

Ability to use Git and Github
Basic knowledge of Dart and Flutter
Basic knowledge of Firebase and willingness to learn more
UI/UX skills are appreciable but not mandatory

Mockups

Hexadecimal Codes

Splash Screen

Light Orange (#FFE2C9) -> White (#fffffff)

Login

Background #FFE2C9-> #FFFFFF

Github #000000

Linkedin #2867B2

Google #ffffff

Button Gradient #FE824A -> #E16831

Orange #E46D39

Home

Cards(Use Soft Colors):

#FFF1F1

#F3F1FF

Team

Red #FF1F1F

Yellow #F5BC00

Green #1CA600

Events

Green #12563A

Button Gradient #FE824A -> #E16831

Element Grey #E5E5E5

How to contribute:

Folder structure

lib : This is where the overall logic of the application lies.

lib\models : The Entire Data Models of the application stays here.

lib\services : The Services of the app such as notification_service lies here.

lib\ui\screens : The Whole Application Screens lies here.

lib\ui\custom : The Custom Widgets you created can be placed here.

Contribution Guidelines

Prerequisites:

Try to reduce the widget tree, in the long run it might help us a lot
When it comes to package version, make sure you use the correct package.
Try to separate the UI from logic.
Improve Documentation, this really helps to understand code.
When it comes to naming convention, maintain similarity and stability through out the app.
If your dart file has more than two widgets try to create separate file.
When it comes to scale our application, try using provider or something similar to that.
Know well about advanced concepts in flutter and try to use them properly.

Steps:

1. Fork this repository.

2. Clone the forked repository.

git clone --depth 1 https://github.com/<your-github-username>/girlscript_app

3. Navigate to the project directory.

cd girlscript_app

4. Create a new branch.

git checkout -b <your_branch_name>

5. Make changes in source code.

6. Commit your changes.

git checkout -b <your_branch_name>

7. Push your local branch to the remote repository.

git push -u origin <your_branch_name>

8. Create a Pull Request!

Finally, go to your repository in browser and click on compare and pull requests. Then add a title and description to your pull request that explains your precious effort.