# README

[![Contributors](https://img.shields.io/github/contributors/juniHub/merng-QAapp-full.svg?style=for-the-badge)](https://github.com/juniHub/merng-QAapp-full/graphs/contributors) [![Forks](https://img.shields.io/github/forks/juniHub/merng-QAapp-full.svg?style=for-the-badge)](https://github.com/juniHub/merng-QAapp-full/network/members) [![Stargazers](https://img.shields.io/github/stars/juniHub/merng-QAapp-full.svg?style=for-the-badge)](https://github.com/juniHub/merng-QAapp-full/stargazers) [![Issues](https://img.shields.io/github/issues/juniHub/merng-QAapp-full.svg?style=for-the-badge)](https://github.com/juniHub/merng-QAapp-full/issues) [![MIT License](https://img.shields.io/github/license/juniHub/merng-QAapp-full.svg?style=for-the-badge)](https://github.com/juniHub/merng-QAapp-full/blob/master/LICENSE.txt) [![Netlify Status](https://api.netlify.com/api/v1/badges/09e91653-d2f5-4352-995d-562ab54ca487/deploy-status)](https://app.netlify.com/sites/juni-ask/deploys)

<br>

[![Logo](https://1924250421-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MaYWtm7zgXS9S4vIjfT%2Fsync%2F93631515789b36c1adf512cce5474c201d45ad0e.png?generation=1621948419586484\&alt=media)](https://github.com/juniHub/merng-QAapp-full)

#### Juni QAs App

project\_description\
[**Explore the docs »**](https://github.com/juniHub/merng-QAapp-full)\
\
[View Demo](https://juni-qa-app.netlify.app/) · [Report Bug](https://github.com/juniHub/merng-QAapp-full/issues) · [Request Feature](https://github.com/juniHub/merng-QAapp-full/issues)

<details>

<summary>Table of Contents</summary>

1. [About The Project](#about-the-project)
   * [Built With](#built-with)
2. [Getting Started](#getting-started)
   * [Prerequisites](#prerequisites)
   * [Installation](#installation)
3. [Usage](#usage)
4. [Roadmap](#roadmap)
5. [Contributing](#contributing)
6. [License](#license)
7. [Contact](#contact)
8. [Acknowledgements](#acknowledgements)

</details>

### About The Project

![Juni-QAs-app-screenshot](https://res.cloudinary.com/dafolrlpj/image/upload/v1627304395/gallery/i4tp939z3ewpig35jdhn.png)

#### Built With

* [ReactJS](https://reactjs.org/)
* [MongoDB](https://www.mongodb.com/)
* [GraphQL](https://graphql.org/)
* [ExpressJS](https://expressjs.com/)
* [Algolia Search](https://www.algolia.com/)
* [Semantic-UI](https://semantic-ui.com/)
* [Backend deployed on Heroku and frontend deployed on Netlify](https://id.heroku.com/)

### Getting Started

#### Prerequisites

* npm

  ```sh
  npm install npm@latest -g
  ```

#### Installation

1. Clone the repo

   ```sh
   git clone https://github.com/juniHub/merng-QAapp-full.git
   ```
2. Install NPM packages

   ```sh
   npm install
   ```
3. Connect to your mongodb and add info in

   ```sh
   config/dev.js
   client/.env
   ```
4. Run the project locally on <http://localhost:5000>

   ```sh
   npm run dev
   ```

### Usage

*For more details, please refer to the* [*Documentation*](https://junitiennguyen.gitbook.io/qa-app)*. This will be continued for update and maintainance.*

### Roadmap

See the [open issues](https://github.com/juniHub/merng-QAapp-full/issues) for a list of proposed features (and known issues).

### Contributing

Contributions are what make the open source community such an amazing place to be learned, inspired, and created. Any contributions you make are **greatly appreciated**.

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

### License

Distributed under the MIT License. See `LICENSE` for more information.

### Contact

Juni Nguyen - [helloJuni](https://hellojuninguyen.netlify.app/)

Project Link: <https://github.com/juniHub/merng-QAapp-full>

### Acknowledgements

Inspired by MERNG series from [Ahmed Hadjou](https://www.youtube.com/watch?v=_DqPiZPKkgY\&list=PLMhAeHCz8S3_pgb-j51QnCEhXNj5oyl8n)