RaiAnsar / girlscript_app

A boilerplate for any technical community to pick up and use for their own without any hastle 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.

Community App Boilerplate 💁

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

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)

How to contribute: 👷

Folder structure

lib : This is where 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.

Coding Guidelines

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

How to make a Pull Request:

1. Fork this repository.

2. Clone the forked repository.

git clone 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 add .
  git commit -m "<your_commit_message>"

7. Push your local branch to the remote repository.

git push -u origin <your_branch_name>

8. Create a Pull Request!

Congratulations! 💥 Sit and relax, you've made your contribution to [GirlScript App] (https://github.com/smaranjitghose/girlscript_app) project.

Resources to get started with: 🔍

• Dart Programming
• Flutter Crash Course
• Firebase and Flutter App Build
• Reso Code's Youtube Channel for best practices
• Official Flutter Documentation
• Hyper Text Markup Language
• Cascading Style Sheets
• JavaScript

Project Admin: 👤

• Smaranjit Ghose

Mentors: 👥

• Sukkrit Sharma

• Saswat Nayak

• Anush Bhatia

• Ousnik Polley