zurichat / zc_core Goto Github PK
View Code? Open in Web Editor NEWThe Zuri Core is an open-source API that serves as the backend and backbone of Zuri Chat
Home Page: https://zuri.chat
The Zuri Core is an open-source API that serves as the backend and backbone of Zuri Chat
Home Page: https://zuri.chat
As a registered user of zurichat I should be able to create a profile for a specific organization I'm in.
As a registered user, I should be able to create an avatar in ZuriChat
Provision an operation that retrieves ALL organization instances in the database
Endpoint: /organizations method=GET
To test:
https://api.zuri.chat/organizations
This endpoint will retrieve a list of all the rooms the authenticated user is in
as a user, I want to be able to send messages to a room
Who is a member?
A member is user (registered on the platform) that is invited to join an organization through invitation links sent to their email.
Schema
Provision an operation to create a member instance in an organization
Endpoint: /organizations/{org_id}/member method=POST body=member_email
As a user of an organization, I should be able to leave a room (or channel) that I am present in and would no longer like to be a part of.
Some tips on choosing a good icon:
File is stored on an external server that returns a url of the image. This url is what is stored.
Endpoint: /organizations/{org_id}/logo POST form file upload
Provision an operation to retrieve a single member record of an organization
Endpoint: /organizations/{org_id}/members/{member_id} method=GET
Provision an operation to alter a member profile image
Endpoint: /organizations/{org_id}/members/{member_id}/image POST file upload
Provision an operation to create organization instance in the database
Endpoint: /organizations method=POST body=owner_email
Provision an operation to alter the value of an organization name
Note
When name is updated, the organization url is also updated, the organization url is set with a default value at the point of creation (since it was not required) e.g. name.slack.com, if name exists already, random word should be appended and verified to be unique before saving. E.g. name-group.slack.com or nameworkspace.slack.com. Organization names are NOT unique, organization url MUST be unique.
Endpoint: /organizations/{org_id}/name method=PATCH body=name
As a new user, I should be able to join zurichat with a verified work email, so that I can join organizations
A user should be able to exchange message with other users present in a room.
Provision an operation to alter the value of a member status
Endpoint: /organizations/{org_id}/members/{member_id}/status method=PUT body=status
UUID should be assigned to the user instead of an id for security reasons.
Provision an operation to alter the value of an organization url
Endpoint: /organizations/{org_id}/url method=PATCH body=url
Newly Registered User(s) data should be saved
As I as a User, I should be able to reset password
As a user I should be able to authenticate my phone number on ZuriChat.
a user should be able to edit a message after deleting it
As a user, i should be able to add information about me and what i do to my profile for a workspace
As an organisation, I want to search for an app so that I can install it without going through the list of all apps
this endpoint should return a list of messages in a particular room
As a user, I should be able to update my profile information for each organization i'm in
Deletes a User with the specified ID
A definition of the schema of an organization instance
Fields:
As a user, i should be able to set timezone so that others in my organization can know my working hours.
As a registered user, I should be able to delete my avatar in ZuriChat
As an organisation, I want to get the list of all apps so that I can install the one(s) I want
As a user with appropriate rights in an organization, i should be able to install approved plugins from the marketplace
Provision an operation that deletes an organization instance in the database
Endpoint: /organizations/{org_id} method=DELETE
Note
*Password verification must be done before operation is executed
Log in and registration with jwt
Provision an operation to retrieve all members of an organization
Endpoint: /organizations/{org_id}/members method=GET
As a user i want to be able to set my status, so others can know when I'm available or not
Company should be able to register with the following information
https://github.com/zuriinternship/zurichat/blob/main/db/users.document.json
User should be able to login with email, password and company_id
As a user in an organization, i want to have a collection of saved items where i can bookmark important items i might need later.
As a plugin that a registered user uses, I want to store the file(s) my user uploaded to the database
Establish a web socket connection so that messages can sync realtime and a user should be able to detect when another user is typing
As a user in an organization, I should be able to join public channels available in that organization
As a new user I should be able to verify my email address
Provision an operation that retrieves a single organization instance in the database
Endpoint: /organizations/{org_id} method=GET
As a User or an Organisation, I want to be able to upload or list custom / third-party apps either for personal or public use in the Marketplace
Activate App will contain logic for activating the organization installed plugin
Create user model with methods to perform crud operations
As an organisation, I want to remove the app(s) that I no longer use or need
As a user, i should be able to update my avatar for a workspace
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.