information_chest

A Flutter application for reading facts and information, just like a digital encyclopedia.

Getting Started

• Setup Git
• Set up flutter and Android Studio
• Or setting up VS code for flutter

Local Setup

• Fork the repo.
• Clone it to your local setup by using the command git clone <repo link>
• Open the project with Android Studio or VS code

Directly cloning from Android Studio (Alternate method):-

• Go to FILE -> NEW -> PROJECT FROM VERSION CONTROL
• Copy and paste the url of FORKED repo in the URL field and click clone.

Before cloning the project make sure you have set up the IDE correctly according to the resources given in the getting started section.

File Structure

Information-Chest
├── README.md
├── analysis_options.yaml
├── pubspec.yaml
├── pubspec.lock
├── icon.svg
├── .github
    └── workflows
        └── flutter-ci.yaml
├── android
├── ios
└── lib
    ├── main.dart
    ├── screens
        ├── around_the_world.dart
        ├── art_sport_enter.dart
        ├── home_screen.dart
        ├── human_body_screen.dart
        ├── natural_world_screen.dart
        ├── planet_earth.dart
        ├── science_and_technology.dart
        ├── universe.dart
        └── world_history_screen.dart
    └── models
        ├── celestial_body_model.dart
        └── science_and_tech_model.dart

How to contribute

• After setting up the project on the local system, go to the issues section to claim issues.
• Remember to regularly pull the updates made by others on the repo to avoid merge conflicts.
• Read all the guidelines carefully before making any pull request on the repo.

Guidelines

Please help us follow the best practice to make it easy for the reviewer as well as the contributor. We want to focus on the code quality more than on managing pull request ethics.

• Single commit per pull request and name the commit as something meaningful, example: Adding <-your-name-> in students section.
• Reference the issue numbers in the commit message if it resolves an open issue.Follow the PR template strictly.
• Do not use unnecessary variables or functions and follow a easy and understandable code structure with proper comments.
• Provide the relevant screenshots for easier review.
• Pull Requests older than 2 days with no response from the contributor shall be marked closed.
• Do not make PR which is not related to any issues. You can create an issue and solve it once we approve them.
• Avoid duplicate PRs, if need be comment on the older PR with the PR number of the follow-up (new PR) and close the obsolete PR yourself.
• Be polite: Be polite to other community members.

Communicate

Whether you are working on an issue or facing a doubt please feel free to ask us on our discord channel. We will be happy to help you out.