Mikutano

Mikutano is a chatting application designed to connect software engineering students to professionals.

Installation

To install Mikutano, follow these steps:
NOTE: all of the following steps are to be perfomed in the repository.

1. Clone the repository:

   git clone https://github.com/wantonraven/mikutano.git

2. Clean the Yarn cache

   yarn cache clean

3. Remove the existing node_modules directory

   rm -rf node_modules

4. Install the project dependencies

   yarn install

5. Build the project

   yarn run build

6. Start Mikutano

   yarn start

Create an Account for Chat Engine

To use Chat Engine in your project and obtain the required private key and project ID, you need to create an account on Chat Engine. Follow these steps to create an account:

• Visit the Chat Engine website (insert website URL).
• Click on the "Sign Up" or "Create Account" button.
• Fill out the registration form with your details, including your email address and a strong password.
• Submit the form to create your account.
• Once your account is created, log in to Chat Engine using your credentials.
• Navigate to the account settings or dashboard section.
• Look for the option to create a new project or access existing projects.
• Create a new project and provide it with a name.
• After creating the project, you should be able to obtain the private key and project ID specific to that project.
• Copy the private key and project ID and use them in the respective files mentioned in the setup instructions above.

To change the keys

• Open the project in your preferred code editor.
• Private Key: In the login.js file, locate the privateKey variable and replace it with your own private key obtained from Chat Engine.
• Project ID: In the chat.js file, locate the projectID variable and replace it with your own project ID obtained from Chat Engine.

Usage

1. From the main page click get started to get in the login page.
2. Login or sign up if you don't have an account.
3. Click on the bar(Chat Title) in the top left corner and type name of chat room of your wish to create a chat room and start a conversation.
4. If you want to chat with someone specific, click on the "People" button in the right middle section, search for their name, and start a conversation with them.

Technologies Used

• React
• Next.js
• Node.js
• ChatEngine

Contributing

If you would like to contribute to Mikutano, please reach out before making any changes to discuss the potential contributions.

Contact

1. Joseph Kakai

• Twitter: wantonraven

• LinkedIn: Joseph Kakai

• Gmail: wanton raven

  2. Purity Chege

• Twitter: Purity Chege

• LinkedIn: Purity chege

• Gmail: Purity Chege

  3. Oluwatosin Orenaike

• Twitter: Oluwatosin Orenaike

• LinkedIn: Oluwatosin Orenaike

• Gmail: Oluwatosin Orenaike

License

Mikutano is released under an open-source license.