opencodeiiita / ask-us-frontend Goto Github PK

Flutter based android app

Kotlin 0.15% Swift 0.51% Objective-C 0.05% Dart 99.29%

flutter dart android-app opencode21 android-studio

ask-us-frontend's Introduction

Ask Us

Ask Us is a flutter based android app. It's basically a discussion forum somewhat like Quora, designed to ask questions, share their experiences and to know what their peeps are up to.

Getting Started

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.

App Design

To get an idea how the app will look like, head over to the following figma link:-

Ask Us Design

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.

IMPORTANT NOTE:- Please attach screenshots of the runnuing app on your emulator of the changes that you have done before making a pr.

Using Api for Backend

The Following endpoints are currently live :-

For posting new questions [POST] :- https://askusdev.herokuapp.com/question/
For getting list of all questions [GET] :- https://askusdev.herokuapp.com/question/
For creating new answer having question id = qid [POST] :- https://askusdev.herokuapp.com/question/{qid}/answer/
For retrieving all answers of question having id = qid. [GET] :- https://askusdev.herokuapp.com/question/{qid}/answer/

Schema :-

Data to be sent in JSON format. Fields required while creating a new question and answer are specified in schema, other fields will be filled automatically.

For any doubt, feel free to ask us on our discord channel.

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 link to live heroku pages from your forked repository or 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.

ask-us-frontend's People

Contributors

Stargazers

Watchers

ask-us-frontend's Issues

Refactoring Fonts folder

In the fonts folder, put all the files directly under fonts folder instead of static folder as it might give error while compiling.

Create Working Navigation bar

The basic structure of the navigation bar was created in Issue #12 and now I want to make it completely working, that means clicking buttons should land on respective pages.

If this issue is selected, I would definitely love to work on it.

Improve UI of Sign Up screen and make it similar to the figma link given. Also make use of the constants.dart file to ensure uniformity throughout the app and if required make changes in constants.dart file.

Openning new issues

If you want to open or work on a new issue you find in the app. Comment here , and if suitable, we will open that as an separate issue.

Make Sign Up screen responsive

Make Sign Up screen responsive, since it is overflowing on some devices.

Adding buttons to profile Screen

Replace icons of upvote, comments and bookmark with icon button and implement the functionality that color bookmark icon changes on tap and upvotes increase. Changes should be reflected in the main list of of data too.

Adding Routing to the Application

Routing helps to Navigate through the different pages of the application.

This issue will help to connect different pages of the app.

If you find this issue good, I like to work on it.

App Icon

Design an appropriate icon for the app. Implement it on the sign up screen.

Hero animation

Add ask us logo on login page and sign up page and add hero animation when the transition happens.

Create Basic Layout of Profile Page

You have to make the basic layout of Profile Page screen.
Check below link for the design of Profile Page screen.
Figma link
Upload dummy data(image and profile info) and kindly ignore bottom Navbar as of now.

Please make sure to code in a new dart file.

Image picker on profile screen is not working

Find Bug in image picker and also increase size of circular avtar to make profile screen UI similar to given Figma Link

Starting point of Linking Backend

Import http package successfully in project. For this make a new dart file and in it make a simple asynchronous function that calls and prints data on the console from the given api :-
Api
Use this as a test api and call the function as soon as the app starts.

Update Font

Add a suitable font for headings and general text in pubspec.yaml file.

Fixing continuous integration

Fix the flutter-ci.yml file updated in pr #25 as it is not working properly.

Add Continuos 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.

Updating readme

Add github actions successful/unsuccessful tag in readme
Adding tips to follow so that your code is a successful build in how to contribute section.

I want to work on this.

Making Routes

Make named routes for buttons like login, Sign up which will push navigator to home screen.

Create basic layout of Answer Screen

You have to make the basic layout of Answer screen.
Check below link for the design of Answer screen.
Figma link
Don't worry about styling as of now just implement basic layout with dummy data.(Implement scrollable view for answer)

Kindly code in a new dart file
Ignore bottom navbar as of now

Improve UI of home screen

Improve UI of home screen and make it similar to the figma link given. Also make use of the constants.dart file to ensure uniformity throughout the app and if required make changes in constants.dart file.

Design App Icon

Design App Icon for Ask Us app.
Add screenshot and drive link of high quality icon in comments below. Whose icon will be selected, he will get the points.

The Last date for this issue is 25 October.

NO NEED TO CLAIM THIS ISSUE.

Refactoring the code

Replace any deprecated property or widget and format the code. Replace repeated code by extracting it in separate class.

Basic layout of Home Screen

You have to make the basic layout of Home screen.
Check below link for the design of Home screen.
Figma link
This is the screen where all the posts from different people will be visible, so make it scrollable (hint:- make a new class for the posts).

Make a new dart file and and populate it with dummy data. As of now do not care about styling just implement basic layout. Ignore bottom navigation bar.

Implementing functionality to post questions

Make a new function in calling-apis.dart file to post a question that the user will input from the question screen. Refer to the readme for api end points and schema.

Implement Bottom Navigation Bar

Implement a Bottom Navigation Bar on the Home Screen. For reference you can check the design on provided figma link.
As of now you don't have to implement any functionality of bottom navigation bar, just make its basic structure.

Adding Image picker for profile picture

Add an edit icon on or near profile picture on profile page and add the functionality to add the selected image from local files to the profile picture.

Basic layout of Sign Up Screen

You have to make the basic layout of sign up screen.
Check below link for the design of sign up screen.
Figma link
As of now you don't have to worry about the styling or designing. Create just basic buttons and text fields.

Please make sure to make a new dart file before start working.

Fixing the issue with continuous integration

Right now the continuous integration setup using GitHub actions to check the code before merging pull request fails at the step:

run: flutter format --set-exit-if-changed .

Fix it. Do changes in the code if required.

Basic layout of Login Screen

You have to make the basic layout of Login screen.
Check below link for the design of Login screen.
Figma link
As of now you don't have to worry about the styling or designing. Create just basic buttons and text fields.

please make sure to make a new dart file before start working.

Improve UI of Login Screen

Improve UI of Login Screen ,style it as in below figma link.
Check below link for the design of Login screen.
Figma Link

Attach screen shot of output

Basic layout of Ask Question Screen

You have to make the basic layout of Ask Question screen.
Check below link for the design of Ask Question screen.
Figma link
As of now you don't have to worry about the styling or designing.