This is a CLI tool which emulates and functions like discord developed as an assignment submission on Dart by Information Management Group.
DartCord helps you to socialise and interact with the comfort of your terminal!
Users can register, login and send personal messages to other users or can go ahead and make servers and channels. DartCord was made in and also gets its name from Dart.
To use this project, you need to have Dart SDK installed on your system. If you haven't installed Dart, you can download it from the official website: Dart SDK.
Once you have Dart installed, you can follow these steps to run the project:
-
Clone the repository to your local machine:
$ git clone (SSH Key)
-
Run the command:
$ dart pub global activate --source path . -
Run the following command to get all the required dependencies:
$ dart pub get
-
Now you can use the 'dartcord' command in your terminal and interact with the CLI.
DartCord has various of features and can be accessed from a list of commands used in the Terminal. Here is a list of commands with a brief description of its usage:
- This will prompt the user to enter and confirm a password after user enters a username of their choice, success upon which the user will be registered on the CLI application.
$ dartcord register <username>- This will prompt the user to enter his password, and if the password is correct, the user would login into the application.
$ dartcord login <username>- This will prompt you to enter message contents which will be sent to the person whose username is provided.
$ dartcord send <receiver username>- This will print the messages sent or received by the user respectively.
$ dartcord print sent$ dartcord print received- This will create a server with no channels initially and the user will be the owner of the server.
$ dartcord createserver <server name>- This will make the user currently logged in join the server with the given servername.
$ dartcord joinserver <receiver username>- This will add a moderator to the server. A moderator is a role with a special status, and has permission to send message on every channel in the server. Only the owner of the server could promote a user in the server to a moderator.
$ dartcord addmod <moderator username> <server name>- This will demote the user from the role of moderator to that of a base user and could only be used by the owner of the server.
$ dartcord removemod <moderator username> <server name>- This will print the list of the moderators in the given server.
$ dartcord printmod <server name>- This will print all the users' usernmes currently in the server onto the Terminal.
$ dartcord showserver <server name>- This will create a channel in th server with the given access to users along with the channel category and channel type. Message can only be sent without any permission in Text and Announcement Channels. Other channels require mod access to send a message (Channel type could be any of them: Text, Voice, Stage, Rules, Announcement).
$ dartcord createchannel <channel name> <category name> <server name>- This would prompt user to enter message contents which will subsequently be sent to the corresponding channel in the server.
$ dartcord message <channel name> <category name> <server name>- This will print all the messages sent by the users in the corresponding channel of the server.
$ dartcord servermessage <server name> <channel name>- This will exit the user currently logged in from the given server unless the user is the owner of the server.
$ dartcord exit <server name>- In case you chose to terminate you account in the application, running this command will delete your userdata and exit you from every server. If you are the owner of the server and there are people besides you, any random person will be made the owner of the channel, otherwise the channel woulf be deleted. (This cannot be undone!)
$ dartcord terminateLicensed under the MIT License