# Project Setup

## Getting Started [<img src="https://emojis.slackmojis.com/emojis/images/1531847273/4225/blob-beers.gif?1531847273" alt="blob beers hangouts blob" data-size="line">](https://slackmojis.com/emojis/4225-blob-beers/download)

### What are the prerequisites ?

* git (to clone the repository).
* node  <= v11.10.1

### How to set up the project locally?

1. Fork  `https://github.com/Ignitus/Ignitus-client.git`
2. Clone `git clone https://github.com/your_username/Ignitus-client.git`
3. Once cloned navigate using  `cd Ignitus-client`
4. Open terminal execute `npm install`
5. Now execute `npm start`
6. Navigate to [http://localhost:3000](http://localhost:3000/) 🚀

#### Docker Setup  🐳

```bash
docker-compose up
```

#### Tools 🔨

A pluggable and configurable linter tool for identifying and reporting on patterns in JavaScript.

To run ESLint use.

```bash
npm run lint
```

This option instructs ESLint to automatically try to fix as many issues as possible. 🛠

```bash
npm run lint:fix
```

{% hint style="info" %}
Please don't commit your `package-lock.json` until & unless you are not adding a new package.
{% endhint %}

{% hint style="info" %}
Please create a new branch from `develop` not from `master`, and please create a pull request to `develop` not to `master`.
{% endhint %}


---

# 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://ignitus-docs.gitbook.io/ignitus/documentation/project-setup.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.
