Skip to content

ladunjexa-pbl/reactjs18-explorium

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

32 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Project Banner Project Banner

Explorium

Explorium is a well-designed Search Engine with content classification tools

contributors last update forks stars open issues license


📔 Table of Contents

🌟 About the Project


Explorium is a Search Engine app with accurate, real-time search engine results by location, device, and language based on SEO API that allows you to find data for SEO, news, images, videos, products and crawlers.

‼️ Folder Structure

Here is the folder structure of Explorium.

Explorium-Search-Engine/
|- public/
|- src/
  |-- assets/
  |-- components/
  |-- contexts/

Now, lets dive into the public and src folders.

public

index.html - manifest.json

The public folder contains the HTML file so you can tweak it, for example, to set the page title. The <script> tag with the compiled code will be added to it automatically during the build process.

src

assets

unfound_illustration.svg - an Illustration that used in case of no results found.

components

Classifier.jsx - Footer.jsx - Loader.jsx - Navbar.jsx - Results.jsx - Router.jsx - Search.jsx

JSX files contain Explorium components which split the UI into independent and reusable pieces.

Classifier.jsx - This component display classification links of data.

Footer.jsx , Navbar.jsx - This components displays the Navigation Bar & Footer.

Loader.jsx - Puff loading component for display while waiting to fetching the results from the API.

Results.jsx - Results component handles the display form of the fetched results, that is, widgets for the various links.

Router.jsx - Router component enables the navigation among views of various components in application.

Search.jsx - Search components (includes search field, search button and classification links).

contexts

ResultContextProvider.jsx - Implementation of Provider React component that allows consuming components to subscribe to context changes, that is, fetch results from API according to data types


🔑 Environment Variables

In order to use Explorium you have to create your SEO-API api key powered by RapidAPI here, to run this web app, you will need to add the following environment variable to your .env file

REACT_APP_RAPIDAPI_SEO_KEY

👾 Tech Stack

NodeJS React TailwindCSS Rapid API

(back to top)

🧰 Getting Started

⚙️ Installation

Step 1:

Download or clone this repo by using the link below:

 https://github.com/ladunjexa/Explorium-Search-Engine

Step 2:

Explorium using NPM (Node Package Manager), therefore, make sure that Node.js is installed by execute the following command in console:

  node -v

Step 3:

At the main folder execute the following command in console to get the required dependencies:

  npm install

Step 4:

Within the main folder create a file named .env and add the following environment variable:

  REACT_APP_RAPIDAPI_SEO_KEY=<YOUR_API_KEY>

🏃 Run Locally

Step 1:

At the main folder execute the following command in console to get the required dependencies:

  npm run start

(back to top)

👋 Contributing

Contributions are always welcome!

See contributing.md for ways to get started.

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  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

(back to top)

⚠️ License

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

(back to top)

🤝 Contact

Liron Abutbul - @lironabutbul6 - @ladunjexa

Project Link: https://github.com/ladunjexa/Explorium-Search-Engine

(back to top)

💎 Acknowledgements

This section used to mention useful resources and libraries that used in Explorium

(back to top)

About

Explorium Search Engine React app using SEO-API powered by RapidAPI ⚛

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •