opencodeiiita / information-chest

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

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.

information-chest's Issues

Design and implement a minimalist UI for Universe.dart screen.

Issue Details:

---

Design and implement the Universe.dart screen UI. Share the design first and then the implementation.

Create a new screen-"Universe" and fetch data using the restAPI provided

The task is as follows:

1. Create a new screen that would contain the information of the celestial objects in the universe.
2. Fetch the data in JSON format from the API: https://api.le-systeme-solaire.net/rest/bodies/
3. Display the raw data in the screen of the JSON extracted.

The provided API gives the information of different celestial objects along with all their information.
The screen route would be connected from the home screen afterward don't take care of that thing, just make the screen and fetch the raw data from the API.

Design an icon for Information Chest

This is a small design task.
Design an icon for information chest application.
Icon should be made as .svg

Implement Splash Screen

Implement a splash screen in the application.
The splash screen should be there from the cold start of the application.

Design and implement UI for ScienceandTechnology screen

Issue details:

---

Design and implement UI for Science and technology screen. First, share the design then implement it.

Create a page listing all the categories.

Create a page listing all the topics and categories listed in #12 .

As of now, hardcoding the list would be sufficient.

Also, there should be some medium to navigate to this page from home page.

Add continuous integration

Adding continuous integration using github actions to check if the app is correctly building or there is an issue in it so that no PR is merged before correcting the error.

This issue will help us remove issues during final build of the app.

If this issue is good to go, I will definitely like to work on it.

Design & build the UI for home screen.

• Home screen UI to be designed along with building its UI.

• There should be a list of the following clickable categories on the home screen as shown in the image.

formatting universe page

Universe page looks kind of a mess I want to present all the info in the readable format and in a listview

if this issue accepted I would like to work on it.

Create named routes for effiecient routing in app.

Issue details:

There would be a number of screens that would be made in the app.
There would be the following screens that would be made as shown in the image.

1. Create named routes according to the screens that would be made in the future by providing additional properties to the MaterialApp constructor
2. Take reference to this link: https://flutter.dev/docs/cookbook/navigation/named-routes

So at the end there would be named routes like :
"/"
"Universe"
"PlanetEarth".....and so on

Solving Issues With the project

Currently in main.dart file there are classes which are not actually present and giving errors.

In this issue, I want to solve this issue by:

1. creating empty classes for each of the route case
2. changing filenames to be starting with lower_case as convention(analysis.yaml present in the project is giving error regarding this)
3. removing unwanted const keywords in the code and refactoring it.

I think it is important to solve these issues in the starting as they are already crashing the build apk command.

If this issue looks good, I want to work on it.

Find a list of public APIs

Open to all issue (All people can work no need to claim, just make PR):

As we are making an app that would contain information, facts, and news of various topics in the list mentioned below. To make the app more informative, there is a need for finding the public APIs that provide all this information. What do you have to do?

1. You would find a folder "apiList" in the project.
2. Find the public APIs after googling or any method you like.
3. In that "apiList" folder make a file "your-github-username.txt" and add all the public APIs you found after googling or in any way from the internet for the information, facts, and news of various topics in the list. (Take reference to the singhalpranav22.txt file that I have created for getting an idea of what you have to do).

Note: Your PR would only be merged when you provide at least two APIs & the APIs are working freely and can be used in the App.

---

The list of topics:

1. The Universe
2. Planet Earth
3. World History
4. The Natural World
5. The Human Body
6. Science and technology
7. Around the world (like landmarks, monuments, etc.)
8. Arts, Sports, and Entertainment

---

Creating Model for Science and Technology API

Well After getting the required json file from the API its being a difficult to extract all the info in a List.
My issue will make a model for Science and Technology API and directly convert json to the model

So, I would like to work on this issue of its approved.

Add splash Screen

Adding splash screen natively to improve User experience during the starting of the program. The splash screen will show the the icon in center with the name of the app.

If this issue looks good, I want to work on it.

Declare the use of internet in Android Manifest file.

Issue details :

---

Add a user permission to use the internet in the app in the AndroidManifext.xml file. For more info: https://flutter.dev/docs/development/data-and-backend/networking

Create a screen for "Science&Technology" and fetch news articles.

Task details:

1. Create a screen "Science&Technology".
2. Fetch the JSON data from the API: https://newsapi.org/v2/top-headlines?country=in&category=science&apiKey=6979a64cc87e45d3bdb9c7056f2120d1
3. Note the API provided above has a key made by me so use judiciously.
4. Print the raw JSON data on the scrollable screen.

The screen route would be connected from the home screen afterward don't take care of that thing, just make the screen and fetch the raw data from the API.