Skip to content

This project aims to create a web application named "API Explorer" using Express/Node.js platform, Axios HTTP client, and a chosen public API from the provided list. The website will interact with the chosen API, retrieve data, and present it in a user-friendly manner.

Notifications You must be signed in to change notification settings

Adesh-111/Api-Explorer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Project Title: API Explorer

Overview

This project aims to create a web application named "API Explorer" using Express/Node.js platform, Axios HTTP client, and a chosen public API from the provided list. The website will interact with the chosen API, retrieve data, and present it in a user-friendly manner.

Screenshot 2024-07-23 195431

image

Objectives

  • Develop an understanding of integrating public APIs into web projects.
  • Gain practical experience in server-side programming using Express/Node.js.
  • Enhance understanding of client-server communication using Axios.
  • Demonstrate the ability to manipulate, present, and work with data retrieved from APIs.

Used APIs

Joke API

  • Create a website that delivers jokes based on user's name.

    image

Bored API

  • Implement a feature that helps users find activities to do when they're bored. Users can specify parameters like the number of participants and activity type to narrow down results.

image

Genderize API

  • Predict the gender of a person based on their first name. This feature can be integrated into the website to provide statistical probability of a name being male or female.

image

Number Facts API

  • Bring meaning to metrics and dates by integrating interesting number facts into the website. Users can learn fascinating facts about numbers shared on the website.

image

GOT API

  • Access data from the universe of Ice And Fire, including information from the HBO series Game of Thrones. Users can explore quantified and structured data from the GOT universe through the website.

image

Lorem Ipsum for Pics API

  • Generate stylish image placeholders for the website. Users can add desired image sizes to the URL to get random images, enhancing the visual appeal of the website with dynamic placeholders.

image

Requirements

  1. API Choice: Choose an API from the provided list that is suitable for retrieving, manipulating, and presenting data in a meaningful and interactive way.
  2. Project Planning: Research the chosen API, its features, and how it will be integrated into the web application.
  3. Project Setup: Set up a new Node.js project using Express.js, including Axios for HTTP requests and EJS for templating. Ensure structured directory and file organization.
  4. API Integration: Implement at least a GET endpoint to interact with the chosen API using Axios for HTTP requests.
  5. Data Presentation: Design the application to present retrieved data in a user-friendly manner using HTML, CSS, and EJS templating.
  6. Error Handling: Implement error handling for both the application and API requests to provide meaningful feedback to users.
  7. Documentation: Include comments throughout the code to explain logic and create a Readme.md file explaining how to start the server and run the code.
  8. Code Sharing: Share the project on GitHub for collaboration and feedback.

Recommended Resources

Readme.md Content

How to Run

  1. Clone the repository to your local machine.
  2. Navigate to the project directory in your terminal.
  3. Run npm install to install dependencies.
  4. Start the server by running nodemon index.js.

Usage

  • Open a web browser and go to http://localhost:3000 to access the web application.
  • Follow the instructions on the website to interact with the chosen API and view the presented data.

Structure

  • index.js: Main file containing server setup and routes.
  • views/: Directory containing EJS templates for rendering HTML pages.
  • public/: Directory for static assets like CSS files and images.
  • README.md: Instructions and information about the project.

Dependencies

  • Express.js
  • Axios
  • EJS
  • Css
  • Node.js
  • Bootstrap

Contributors

  • Adesh D

Feel free to contribute, provide feedback, or suggest improvements by opening an issue or pull request on GitHub.

About

This project aims to create a web application named "API Explorer" using Express/Node.js platform, Axios HTTP client, and a chosen public API from the provided list. The website will interact with the chosen API, retrieve data, and present it in a user-friendly manner.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published