aossie-org/resonate

Clubhouse, but Open Source. A social voice platform.

resonate's Issues

Add a splash screen

Currently when the app restarts, we get to see the login screen for a second or so even if we are logged in. This leads to bad user experience. A better approach is to have a splash screen until the authentication controller checks if the user is already logged in and then navigate accordingly.

UI: Implement App Screens

This issue tracks the implementation of UI designs/views. We can work on improving the UI and add elements as and when required. For now, the following screens/widgets have to be implemented. Feel free to make improvements to the proposed design.

• SignIn/SignUp Screen
• User Onboarding Screen
• Rooms List Screen
• Single Room Screen
• Create Room Popup
• Profile Screen

SignIn Screen	Signup Screen	User Onboarding

Rooms Screen	Create Room Popup	Single Room Screen

Implement ApiService Class

Create an ApiService class inside the services folder which has methods to talk to Resonate's backend API.

Migrate Backend from Firebase to Appwrite

We have decided to migrate our project's backend infrastructure from Firebase to Appwrite. This issue serves as a central point to track the progress, discuss challenges, and coordinate the migration process.

Checklist

• The codebase has been refactored to use Appwrite APIs and SDKs.
• Existing functionality has been thoroughly tested after migration.
• Relevant stakeholders have been notified about the migration from Firebase to Appwrite.
• Documentation has been updated to reflect the changes made.

Get user data on signup with google

Onboarding screen is not appearing when a user signs up with Google.

Disable support for Web and Desktop

Since our goal as of now is just to develop app for Android and iOS, we can disable web and desktop-related things. This makes our projects a little cleaner and lighter.

Make sure to use conventional commit structure as follows:

<type>: <short summary>
  │               │
  │               └─⫸ Summary. Not capitalized. No period at the end.
  │
  └─⫸ Commit Type: docs|feat|fix|perf|refactor|test

App crashes on launch if there is no internet connection

Email Verification Screen Needed

An Email verfication screen and logic needed while sign up to avoid users to enter false emails and to ensure the email entered belongs to them would implement OTP format to validate emails

bottom ui overflow by 318 px

There is UI error at create-room-screen . The Start button overflows while keyboard appears

Document the architecture

State how you are going to build something like a Clubhouse or Twitter spaces.

• How is audio streaming going to be handled
• How are people going to join in a space

A lot of questions. Research and come up with answers.

Refactor Onboarding Functionality to a different controller

Previously, onboarding was taken care by profile controller. Since onboarding is a one time task, it will not be efficient to use it in profile controller which gets created every time the user uses the app or goes to profile screen.

Add a default profile image

A default profile image should be used if the user doesn't upload an image of his own.

Implement GetX Architecture

Use Getx for State Management, and create a directory structure for it.

Sort Participants based on their role

Currently all participants are getting displayed in random order. Lets make it in order like first the Admin comes in, then the moderator, the speakers and then the listeners.

Suggestion: Need of Delete Account Button in Profile Screen

While debugging I had to create a lot of dummy accounts this led to a need of including a delete account Button in the profile screen allowing others to delete their account if required hence allowing other users to be able to use the username they were previously holding

Would like to work on it

docs: add appwrite setup instructions

Add instructions to setup Appwrite according to our project. Update the readme file.

Check if username is already taken

Currently, two users can use the same username. Hence, its required to develop a mechanism to check if the username is valid and not taken already. On firebase, this can be achieved by adding a usernames collection with usernames as document IDs and each document has a uid string containing the UID of the user linked to that username and developing a logic to implement it in the view.

Feature to request speaker role

Currently, the user joins the room with speaker role. Lets make it Listener role by default and then the user can raise hand to request speaker role for the room.

Design a basic logo and app icon

Keeping in mind the colour scheme used by AOSSIE's website, design a basic minimalistic logo and app icon.

Add form validation in User Onboarding Screen

After signup, the user will get an onboarding form to fill. But it gets submitted even if the user doesnt fill any information.

A Null image as Profile is shown if the user does not provide an Image

I am currently working on this issue setting the placeholder image as the profile picture of the user incase of no image provided by user can also implement to set different placeholders specific to Gender if required..

Replace userEmail with appwrite UID in API calls

Changes are being made to the API to use user's UID rather than userEmail for creating and joining rooms. Hence we have to replace API calls from userEmail to appwrite UID.

Give Incorrect Password Feedback to the User

Currently, if the password is incorrect the error is being catched but the user is not getting any feedback on the frontend saying that the password was invalid. This has to be added to improve the user experience.

Remove password validation in login screen

Form validation had to be added to login and signup forms.

Readme file needs to be updated

A new Readme file should be created for this repo explaining the tech stack, mentors details ...

Feature to share room links

Implement deep linking to share rooms using links on other platforms.

Feature for admins to assign moderators for the room

Implement Room Management using Appwrite

Create a RoomService Class and implement createRoom, JoinRoom, LeaveRoom and DeleteRoom methods. Make use of the API service class.

Use Freezed to define ResonateUser model

Add loading indicator

Loading indicator has to be added for the following.

• While uploading profile image
• While saving the user data (onboarding screen)

Make use of loading_animation_widget package.

Need for Logo Icon for Resonate

An app logo icon I believe is needed for Resonate along with its design needs to be finalized I believe it would differ from the AOISSIE-Org logo.

Currently being the default flutter logo, after finalizing the logo the splash screen I believe might also have to be updated the finalized logo being at the center with the organizations logo being at bottom center

Suggestion: Loading Animation for Resonate

A loading animation for Resonate replacing the default flutter loading animation (splash screen which provides a loading animation when Resonate starts currently a default flutter loading animation is being shown would customize it for Resonate )

Would like to work on it

Null check on Null value for profile screen

Faced problem in displaying profile screen despite correct logic being implemented in the tab view screen

Create design wireframes for the app

Use tools like Figma or Sketch to design the wireframes.

Get user data if not available on firestore

There's a scenario wherein

1. The user registers a new account
2. When the onboarding screen appears, user closes the app and reopens it
3. Now, there is inconsistency in user data on firestore (i.e user has not filled onboarding form)

This has to be fixed.

Setup starting point of App

Develop the landing or onboarding screen of the App. This is the first screen on opening the app.

Setup AuthO for User Auth

We will use Auth0 for authentication and authorization for users on the app.

Show placeholder if there are no active rooms

Introduce a `develop` branch (GitFlow Workflow)

This project only has a master branch which will be used for maintaining the releases. I think there is a need for a develop branch so that the main branch is unaffected even if there are some breaking changes in the develop branch.

Refer to this:

1. Why need Develop Branch in GitFlow
2. GitFlow Workflow

Also, let us set up a contributing guidelines file.

Feature to remove/replace Profile Image

Finalize Firebase Firestore Structure

Here is a basic idea of how we can structure the Firestore database. Let's discuss and come to a final structure before implementing the same.

Add Google Sign In with AuthO

Add SSO with Google

Explore and integrate WebRTC for multi-user Audio comms

Implement WebRTC SDK and test out multi-user audio comms.

Add New User Registration Flow

As of now, there is just a simple signup page asking for email address and the password. We have to add a form to collect basic user details like name, profile pic etc.

Store user info in `user-data` database

Currently, we are storing user data filled by the user in onboarding screen in user's preferences. We will have to store it in user-data database so that we can access it while creating single room screen with participants.

Need for an edit option in profile screen which launches a edit profile screen

Edit profile screen would allow the user to edit their username, display name, email and profile Image

This screen might also have a delete account option for now would navigate it to a settings screen if generated in future

Hey @chandansgowda would like to work on it

Create MVC Folder Structure

Structure the project using MVC design pattern

Implement LiveKit Room Service

Create a controller to manage LiveKit room using the methods provided by the LiveKit Client SDK for Flutter.

Perf: Compress profile image and change upload logic

Currently, we are just uploading the image selected by user to firebase without any compression. This feature has no size limit too. It would be better to limit the image size to 100kb and/or compress it before uploading to firebase storage.
We can make use of the imageQuality parameter in the image_picker's pickImage method.
We can discuss more on the size limit if required.

Implement controllers for Home, CreateRoom and Room Screen

• Create Room Controller
• Home (Rooms) Controller
• Single Room Controller