README

Juni QAs App

project_description Explore the docs » View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project

   • Built With

2. Getting Started

   • Prerequisites

   • Installation

3. Usage

4. Roadmap

5. Contributing

6. License

7. Contact

8. Acknowledgements

About The Project

Juni-QAs-app-screenshot

Built With

• ReactJS

• MongoDB

• GraphQL

• ExpressJS

• Algolia Search

• Semantic-UI

• Backend deployed on Heroku and frontend deployed on Netlify

Getting Started

Prerequisites

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/juniHub/merng-QAapp-full.git

2. Install NPM packages

   npm install

3. Connect to your mongodb and add info in

   config/dev.js
   client/.env

4. Run the project locally on http://localhost:5000

   npm run dev

Usage

For more details, please refer to the Documentation. This will be continued for update and maintainance.

Roadmap

See the open 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

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

Acknowledgements

Inspired by MERNG series from Ahmed Hadjou