Clique Frontend

Welcome to the Clique frontend repository! built with ReactJS, Vite, JavaScript, Redux, and CSS. In this document, you will find detailed information about the project, and guidelines for contributing to this project.

Please note that the frontend and backend repositories are separate. If you're looking for the backend repository, you can find it here.

Table of Contents

• Project Overview
• Screenshots
• Features
• Technologies Used
• Getting Started
  • Environment Variables
  • Installation
• Roadmap
• Contribution Guidelines
  • Creating an Issue
  • Working on an Issue
  • Commit Guidelines
  • Pull Requests
• Contact

Project Overview

Clique is a platform where users can host/join live audio conversations with others on various topics similar to Twitter spaces. The frontend of the project is built using ReactJS, Vite, JavaScript, Redux, and CSS.

Screenshots

Features

• Live audio conversation: Users can host and participate in live audio conversations with others on various topics.

Technologies Used

The frontend of the Clique is built using the following technologies:

• ReactJS
• Vite
• JavaScript
• Redux
• CSS

Getting Started

To get started with the Clique frontend project, follow the instructions below.

Environmental Variables

To run this project, you will need to add the following environment variables to your .env file

VITE_API_URL=http://localhost:5500/

Installation

1. Clone the repository to your local machine:

   git clone https://github.com/shaqeebakhtar/clique.git

2. Navigate to the project directory:

   cd clique

3. Install the dependencies:

   npm install

4. Start Development Server

   To start the development server, use the following command:

   npm run dev

This will start the frontend application and it will be accessible at http://localhost:5173/.

Roadmap

• Add moderation - Hosts can have the ability to mute, remove, and add anyone as a speaker.

• Users can request to be a speaker.

• Ability to create spaces as public, private, and unlisted.

Contribution Guidelines

We welcome contributions from the community to make Clique better. If you would like to contribute, please follow the guidelines below.

Creating an Issue

If you have found a bug, have a feature request, or want to suggest an improvement, you can create an issue on the GitHub repository. Please provide a clear and detailed description of the issue or suggestion.

Working on an Issue

If you want to work on an existing issue, please follow these steps:

1. Comment on the issue that you want to work on it, to let others know that you're working on it.

2. Fork the repository to your own GitHub account.

3. Create a new branch for your contribution:

   git checkout -b my-contribution

4. Make your changes and commit them with appropriate messages following the commit guidelines.

5. Push your changes to your forked repository:

   git push origin my-contribution

6. Create a pull request from your forked repository to the main repository's main branch.

Commit Guidelines

I want you to follow the Conventional Commit Types guidelines for commit messages. This helps to maintain a consistent commit history and makes it easier to understand the changes made in each commit.

Please use the following format for your commit messages:

<type>: <description>

Example commit messages:

feat: Add user authentication endpoints

chore: Update dependencies

docs: Update README with contribution guidelines

refactor: Rename variables for better readability

Pull Requests

To submit your changes for review, create a pull request with the following information:

• Provide a clear and descriptive title for your pull request.
• Include a summary of the changes you have made.
• Reference any related issues using the GitHub issue number.

Contact

If you have any questions or need further assistance, you can reach out to the me:

• Name: Shaqeeb Akhtar
  • Email: [shaqeebakhtar01@gmail.com]
  • Twitter: shaqeeb_akhtar

Thank you for your interest in contributing to Clique! We appreciate your support.