Welcome to Kujua web search App!

This is a simple web search application

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

NOTE:

This app is made up of two parts:

1. Frontend (Developed by Victor KARANGWA)

2. Backend (Developed by Rapid API):

   1. Search results: faroo-faroo-web-search
   2. Link shortening: shorturl-sfy-cx

Prerequisites

• Any Web Browser (We recommend using Google Chrome)
• Text Editor (We recommend using VSCode)
• Node Package Manager

Cloning the project

• Simply Clone The project
• OR use git bash:
  1. First download git bash
  2. Install it
  3. Clone it by running git clone https://github.com/victorkarangwa4/kujua-web-search.git
  4. Find the project directory from where you are running the terminal.

Running the tests

1. Open command prompt
2. navigate to the directory of cloned project
3. Run the automated test by running npm run test command

Running the application

Remote app

Kujua Web search

Running the app locally

1. clone this project
2. Open terminal from the root directory
3. Run npm install to install app dependencies
4. Finally, run npm run serve to start the server
5. App should open itself from you default browser

Using the application

1. Assuming that the app is running from your default browser
2. You will see an input box where you can search for a certain thing from internet

Built With

• User interface library: React JS
• Linting Library: ESLint
• Style Guide: Airbnb
• Testing Framework: Jest
• Hosting: Heroku

Contributing

1. Fork it
2. Create a branch (git checkout -b my_project)
3. Commit your changes (git commit -m "Added Stuff")
4. Push to the branch (git push origin my_project)
5. Create an Issue with a link to your branch

Author

Victor KARANGWA

License

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