Skip to content

Commit

Permalink
add: Extender README information
Browse files Browse the repository at this point in the history
  • Loading branch information
lyudmil-mitev committed Oct 10, 2024
1 parent 173d295 commit e2baca5
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 2 deletions.
40 changes: 39 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,49 @@

Rick and Morty 100 years! Rick and Morty 20 Seasons!

## [Open in GitHub Pages](https://lyudmil-mitev.github.io/rick-and-morty-explorer/)

This is a React application built with React, React Router v6, TailwindCSS, Vite, Vitest and the Rick and Morty API

## Features
- Simple responsive design implemented with TailwindCSS
- Supports Light/Dark mode (auto detected from Operating System Theme)
- Awesome hover animations
- Paginated listings of Characters, Locations and Episodes
- Extensive detail pages for Characters, Locations and Episodes
- Custom Error page

To clone the application run:

```
https://github.com/lyudmil-mitev/rick-and-morty-explorer.git
```

To run the development server, use:

```
npm install
npm run dev
```

This project uses the [Rick and Morty API](https://rickandmortyapi.com/)
Then, to run the tests, use:
```
npm run test
npx vitest --coverage # Measure test coverage
```

To create a local build run:
```
npm run build
cd dist && ln -s . rick-and-morty-explorer # Symlink rick-and-morty-explorer, because that's configured as a base dir in vite.config.ts due to github pages structure
```


## Credits
- Rick and Morty is a copyright and trademark of The Cartoon Network, Inc, Adult Swim, Justin Roiland, Dan Harmon and others.
- This is a fan project for educational purpose and is in no way affiliated to them.
- The data and images are used without claim of ownership and belong to their respective owners.
- The title font is made and [generously provided by John Izaak](https://www.deviantart.com/jonizaak/art/Get-Schwifty-A-Rick-and-Morty-font-638073728)
- The deep space background svg image is adapted from [work by Bence Szabo](https://www.deviantart.com/jonizaak/art/Get-Schwifty-A-Rick-and-Morty-font-638073728)
- This project includes posters for seasons from tvmaze.com
- This project uses the [Rick and Morty API](https://rickandmortyapi.com/)
2 changes: 1 addition & 1 deletion tsconfig.app.tsbuildinfo
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"root":["./src/loaders.ts","./src/main.tsx","./src/vite-env.d.ts","./src/components/Banner.tsx","./src/components/CharacterCard.tsx","./src/components/DetailsLayout.tsx","./src/components/EpisodeCard.tsx","./src/components/LocationCard.tsx","./src/components/MiniCard.tsx","./src/components/Pagination.tsx","./src/components/TabBar.tsx","./src/routes/CharacterDetails.tsx","./src/routes/Characters.tsx","./src/routes/EpisodeDetails.tsx","./src/routes/Episodes.tsx","./src/routes/LocationDetails.tsx","./src/routes/Locations.tsx","./src/routes/Root.tsx"],"version":"5.6.2"}
{"root":["./src/loaders.ts","./src/main.tsx","./src/vite-env.d.ts","./src/components/Banner.tsx","./src/components/CharacterCard.tsx","./src/components/DetailsLayout.tsx","./src/components/EpisodeCard.tsx","./src/components/LoadingSpinner.tsx","./src/components/LocationCard.tsx","./src/components/MiniCard.tsx","./src/components/Pagination.tsx","./src/components/TabBar.tsx","./src/mocks/characterDetail.mock.tsx","./src/mocks/characters.mock.tsx","./src/mocks/episodeDetail.mock.tsx","./src/mocks/episodes.mock.tsx","./src/mocks/locationDetail.mock.tsx","./src/mocks/locations.mock.tsx","./src/routes/CharacterDetails.test.tsx","./src/routes/CharacterDetails.tsx","./src/routes/Characters.tsx","./src/routes/EpisodeDetails.test.tsx","./src/routes/EpisodeDetails.tsx","./src/routes/Episodes.test.tsx","./src/routes/Episodes.tsx","./src/routes/ErrorPage.test.tsx","./src/routes/ErrorPage.tsx","./src/routes/LocationDetails.test.tsx","./src/routes/LocationDetails.tsx","./src/routes/Locations.test.tsx","./src/routes/Locations.tsx","./src/routes/Root.test.tsx","./src/routes/Root.tsx"],"version":"5.6.2"}

0 comments on commit e2baca5

Please sign in to comment.