search

mosharaf13 / fleet-searcher

Upload a CSV file containing keywords and view google search stats
2 stars 0 forks source link

readme

Fleet Searcher

Description

fleet-searcher is a web application that allows you to search google using a CSV file fo keywords and view stats in it.

Requirements

Installation

  1. Clone the repository:
git clone git@github.com:mosharaf13/fleet-searcher.git fleet-searcher
  1. Navigate to the project directory:
cd fleet-searcher
  1. If you don't have the dependencies installed. Run the following command
bash setup/install_dependencies.sh
  1. Logout and log back in to the terminal.
  2. Then Start the app running the following script
bash setup/start_app.sh

Usage

Once the Docker containers are up and running, you can access the application in your web browser at http://localhost. From there, you can perform searches on google and view the results.

The default port for this application is 80. If you want to start the application on another port set  APP_PORT="YOUR PORT" in .env

Testing

You can run the automated tests for the application using PHPUnit. To run the tests, use the following command:

./vendor/bin/sail test

If you want generate code coverage then run

.vendor/bin/sail test --coverage-html ./coverage

License

The Fleet Searcher project is open-source software licensed under the MIT license.