This is the Zuri Chat Android app project repository handled by TEAM SOCRATES, written with pure Flutter.
NB: Always contact Team leads before attempting any task except assigned to.
All team members must adhere to the following instructions while working on this project.
Make sure you understand the project architecture before proceeding with any task.
ZuriChat is a mobile application clone of the already existing slack application with extra features like music room, chess room, meeting room etc etc.
Music room: A room for shared playlist where users can add, play and share songs amongst one another.
Meeting room: A room where meetings can take place amongst members. The meeting room also has a whiteboard where designs and texts can be created to better visualize points of discussion and for better understanding.
Documentation room: A room that has the company's documentation, files and folders and so on.
Avatar room: A room where you can design or choose an avatar that best describes your expression.
The figma design that will be implemented for this project can be found here
Here is the link to the app hosted on appetize.
i. Naming Convention:
Naming Convention | Effective Style | Example |
---|---|---|
Classes, enum types,typedefs,and type parameters,etensions | PascalCase | An example is HomeScreen |
Libraries, packages, directories, and source files, import prefixes | snake_case | An example is home_screen |
Class members, top-level definitions, variables, parameters, and named parameters, constants | camelCase | An example is verifiedUser |
ii. Style Rule
Indent your code where appropriate (e.g Use two-space indentation.)
Click Here to know more
Steps to collaborate on the repository for team members.
git clone
"https://github.com/your-github-username/zc_app.git"git remote add upstream
"https://github.com/Valenteeena/zc_plugin_channels"
git pull upstream develop
When your task is completed:
git checkout -b feat/yourTask
Push to github;git add .
git commit -m "feat: Inplemented yourTask"
git pull upstream develop
git push origin "feat/yourTask"
note how it end with a branch.When making a PR, your PR is expected to have the following comments"
You can check out this document for further information on the architecture.