# Mumble Repository

## Directory Structure

You can find project information, licence, contribution guidelines, style guides and more on the root directory. However, the main source code for the Mumble project lives on the `frontend` folder. This project is create with `create-react-app` and we respect what `create-react-app` provides us by default. Although in future, the directory structures can be changed a bit, but for the most part the current directory structure looks like this:

```bash
|-- cypress
|-- node_modules
|-- public
|-- src
    |-- __tests__
    |   |-- components
    |-- actions
    |-- assets
    |   |-- images
    |   |-- logo
    |-- common
    |-- components
    |-- constants
    |-- data
    |   |-- images
    |-- hooks
    |-- pages
    |-- reducers
    |-- services
    |-- styles
    |   |-- common
    |   |-- components
    |-- uikit
    |   |-- scripts
    |   |-- styles
    |       |-- modules
    |-- utilities
```

## Download & Setup Instructions :

Before downloading the project, check to make sure you meet the [project's requirements.](https://github.com/divanov11/Mumble/blob/master/REQUIREMENTS.md)

Clone the project. This will download the GitHub respository files onto your local machine.

```
git clone https://github.com/divanov11/mumble
```

## Frontend Instructions (Create React App) :

\---> Navigate to the `frontend/` directory

```
cd Mumble && cd frontend
```

\---> Install the project dependencies

```
npm install
```

\---> Start the development server on localhost:3000

```
npm start
```

## Want to Contribute?

Check out the [contributing guide](https://github.com/divanov11/Mumble/blob/master/CONTRIBUTING.md). Also if you are looking for a complete style guides, please refer to [**Mumble Style Guide**](https://github.com/MidouWebDev/Mumble-docs/tree/e7e8a918ac17a819790344c72d376133019cf9d5/About%20Mumble%20Project/STYLE_GUIDE.md). We highly recommend to go through the guideline before start contributing.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://midouwebdev.gitbook.io/mumble-docs/about/mumblerepository.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.