Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hernandosebastian/rick-and-morty-wiki

Rick and Morty Wiki is a web app with a user-friendly interface. It fetches character data from the Rick and Morty API, utilizing caching for optimal performance. Built with HTML, CSS, Bootstrap and JavaScript, it follows a modular architecture, employing ES modules, entities, mappers, and services. Includes Jest for testing.
https://github.com/hernandosebastian/rick-and-morty-wiki

bootstrap css entity esmodules html javascript jest-tests localstorage mapper netlify oop rickandmortyapi unit-testing wrapper

Last synced: 13 days ago
JSON representation

Host: GitHub
URL: https://github.com/hernandosebastian/rick-and-morty-wiki
Owner: hernandosebastian
Created: 2023-01-06T18:39:57.000Z (almost 2 years ago)
Default Branch: main
Last Pushed: 2023-06-18T20:21:17.000Z (over 1 year ago)
Last Synced: 2024-11-27T05:27:15.350Z (about 1 month ago)
Topics: bootstrap, css, entity, esmodules, html, javascript, jest-tests, localstorage, mapper, netlify, oop, rickandmortyapi, unit-testing, wrapper
Language: JavaScript
Homepage: https://rickandmortywiki-mipmipp.netlify.app
Size: 4.45 MB
Stars: 2
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# ![Favicon](https://raw.githubusercontent.com/Mipmipp/rick-and-morty-wiki/main/src/assets/favicon.png) Rick and Morty Wiki

This is a Rick and Morty Wiki page where you can find information about various characters from the show. It is made by consuming the [Rick and Morty API](https://rickandmortyapi.com/).

## Description

This website allows you to explore the world of Rick and Morty by providing details about different characters. You can find information such as their place of birth, current location, status, and more.

## Technologies Used

- HTML5
- CSS3
- JavaScript (ES modules)
- Jest
- Bootstrap

## Features

- Responsive design for seamless browsing on various devices.
- Integration with the Rick and Morty API to fetch character data.
- User-friendly interface with intuitive navigation.
- Caching mechanism implemented using JavaScript vanilla.
- Rigorous Jest unit testing to ensure the application functions flawlessly and catches any potential bugs.
- Implementation of entities, mappers, and services as classes, providing a modular and organized architecture for better maintainability and extensibility.

## Jest Coverage

The application has been thoroughly tested using Jest, achieving 100% coverage. This ensures that every line of code is tested, minimizing the chances of errors and bugs.

## Demo

You can visit the Rick and Morty Wiki by clicking [here](https://rickandmortywiki-mipmipp.netlify.app/). It is deployed using Netlify.

## Installation

1. Clone this repository on your local machine.
2. Open a terminal in the project folder.
3. Run the following command to install the dependencies:
```bash
npm install
```
4. Once the installation is complete, you can start the application with the following command:
```bash
npm run start
```
5. Access the application in your browser through the URL: http://localhost:3000.

## Contact Me

If you have any questions, suggestions, or feedback, feel free to reach out to me.

- Email: [[email protected]](mailto:[email protected])

## Screenshots

Here are some screenshots of the Rick and Morty wiki website:

_Rick and Morty wiki website view on PC._

PC view

_Rick and Morty wiki website view on phone._

phone view