Skip to content

Bhdrpkcn/picklepedia

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

picklePedia Rick and Morty API Project

This project retrieves character, episode, and location data from the Rick and Morty API and provides users with a user interface to filter and paginate this data. This README file provides step-by-step instructions for running and customizing the project.

Getting Started

To run this project on your local machine and customize it, follow the instructions below.

Requirements

To run this project, you'll need the following software and tools:

Installation

  1. Clone this repository to your local machine or download it as a ZIP file.

``shell git clone https://github.com/Bhdrpkcn/picklePedia.git

  1. Navigate to the project directory.

cd picklePedia

  1. Install the required dependencies.

npm install

Running

After successfully installing the project dependencies, you can use the following command to start the application:

npm start

The application will run at http://localhost:3000 in your web browser. Open your web browser to view the application.

Usage

This section should include examples and instructions on how to use the application. Focus on the following topics:

  • Filtering character, episode, and location data
  • Navigating through the data using pagination
  • Searching for data using the search feature

Contributing

If you wish to contribute to the project, you can follow these steps:

  1. Fork this repository to your GitHub account.
  2. Create your branch to add a new feature or make fixes.
  3. Make your changes and edits.
  4. Ensure your changes pass the tests.
  5. Push your changes to your repository branch and create a pull request.

License

This project is licensed under the MIT License. Please see the license file for detailed information.

Contact

If you have any questions or feedback, please feel free to reach out to me: bhdrpkcn@gmail.com

Releases

No releases published

Packages

No packages published