/Peper-Analysis

Primary LanguageJupyter NotebookMIT LicenseMIT

Peper-Analysis

Peper-Analysis_logo

An intelligent analyzer and visualizer of natural language reviews from AirBNB and TripAdvisor.

How to install and run the app?

We are using Python and JavaScript as main programming languages, so we will have to setup both sides in order to run the app.

Installation

  1. Since our back-end is written using Node.js, you will need to download it from here.
  2. Once you have Node.js you will need to install the packages we used to build this project, specified in package.json.
    Navigate to the root directory of the project and run the following:
    npm install
  3. Now, that we are done with JavaScript's dependencies, lets continue with Python's. Of course you will need to download the Python programming language. You can do so from here.
  4. Now, because we are using virtual environment to manage our dependencies, you will need to download Pipenv.
    Check out here to understand how to do so.
  5. Once you have installed Pipenv you are ready to install the requirements specified in the Pipfile.
    Navigate to the root directory of the project and run the following:
    pipenv install
  6. Good Job! Now you are all setup to run the app.

Running

  • Navigate to the root directory of the project and run the following:

    node index.js [path_to_the_python_executable]
  • You can get your path_to_the_python_executable by running:

    pipenv --venv

This will return a path, add /bin/python to this path and this whole string pass to node index.js.

  • For a shortcut you can try running this:
    node index.js $(pipenv --venv)/bin/python

Built With

  • Node.js - The back-end framework used

Contributing

Please read [CONTRIBUTING.md] for details on our code of conduct, and the process for submitting pull requests to us.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE file for details