Skip to content

Latest commit

 

History

History
178 lines (106 loc) · 7.78 KB

README.md

File metadata and controls

178 lines (106 loc) · 7.78 KB
Raw

GirlScript App

Issues Pull Requests Forks Stars License

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 :octocat:
  • Basic knowledge of Dart and Flutter
  • Basic knowledge of Firebase and willingness to learn more
  • UI/UX skills are appreciable but not mandatory

Mockups 📝

feed example

Hexadecimal Codes :octocat:

Splash Screen

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

Login

Background #FFE2C9 #FFE2C9-> #FFFFFF #FFFFFF
Github #000000 #000000
Linkedin #2867B2 #2867B2
Google #FFFFFF #ffffff
Button Gradient #FE824A #FE824A -> #E16831 #E16831
Orange #E46D39 #E46D39

Home

Cards(Use Soft Colors):
#FFF1F1 #FFF1F1
#F3F1FF #F3F1FF

Team

Red #FF1F1F #FF1F1F
Yellow #F5BC00 #F5BC00
Green #1CA600 #1CA600

Events

Green #12563A #12563A

Button Gradient #FE824A #FE824A -> #E16831 #E16831

Element Grey #E5E5E5 #E5E5E5

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.

Contribution Guidelines

👇 Prerequisites:

Pass

  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.

Steps:

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.

changes

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.

click on Compare and Pull Request

Congratulations! 💥 Sit and relax, you've made your contribution to GirlScript App project.

Code of Conduct:

code_of_conduct

Make sure you don't violate this

Contributors:

👨 Project Admin

Smaranjit Ghose

Project Maintainers and Mentors 👬

Code of Conduct

License 📝

Refer to LICENSE.