react-carousel
A pure extendable React carousel, powered by Brainhub (craftsmen who ❤️ JS)
File Explorer
Download Latest Version (.zip)- config.yml
- bug_report.md
- feature_request.md
- pull-request-template.md
- Arrows.test.js
- ClickToChange.test.js
- ControlledInput.test.js
- Dots.test.js
- Infinite.test.js
- MoveSlides.test.js
- Thumbnails.test.js
- index.js
- commands.js
- index.js
- carousel.md
- dots.md
- plugins.md
- decision-log.md
- labels.md
- workflow.md
- animation.md
- centered.md
- clickToChange.md
- controlled.md
- customArrows.md
- defaultArrows.md
- dots.md
- flexContainer.md
- infinite.md
- lazyload.md
- multipleSlides.md
- resizableCarousel.md
- responsive.md
- rtl.md
- simpleUsage.md
- slidesToScroll.md
- swipingSlides.md
- thumbnails.md
- plugins.md
- CHANGELOG.md
- gettingStarted.md
- migrationGuide.md
- .gitkeep
- 404.js
- landing.js
- landing.module.scss
- variables.scss
- favicon.png
- mona.jpg
- mona_thumbnail.jpg
- scream.jpg
- scream_thumbnail.jpg
- starry-night.jpg
- starry-night_thumbnail.jpg
- carousel.scss
- .gitkeep
- globalReferences.js
- example.md
- deploy-github.sh
- seed.sh
- .babelrc
- .gitignore
- gatsby-config.js
- gatsby-docs-kit.yml
- LICENSE
- package.json
- README.md
- blacklist.js
- licenses.js
- whitelist.js
- Carousel.js
- CarouselDots.js
- CarouselSlide.js
- CarouselWrapper.js
- carouselStrategies.js
- config.js
- plugins.js
- pluginsOrder.js
- useEventListener.js
- useOnResize.js
- arrows.js
- arrows.scss
- autoplay.js
- centered.js
- clickToChange.js
- fastSwipe.js
- index.js
- infinite.js
- rtl.js
- rtl.scss
- slidesToScroll.js
- slidesToShow.js
- carouselAtoms.js
- slideAtoms.js
- carouselSelectors.js
- Arrows.scss
- Carousel.scss
- CarouselDots.scss
- CarouselItem.scss
- carouselPluginResolver.js
- clamp.js
- getChildren.js
- simulateEvent.js
- index.js
- styleMock.js
- arrows.test.js
- autoplay.test.js
- dots.test.js
- infinite.test.js
- rtl.test.js
- slidesPerScroll.test.js
- setupCarousel.js
- carousel.test.js
- build.js
- chalkConfig.js
- .babelrc
- CHANGELOG.md
- jest.config.js
- jest.setup.js
- LICENSE.md
- package.json
- README.md
- webpack.config.prod.js
- carousel.gif
- logo.gif
- thumbnails.gif
- deploy-gh-pages-pr.sh
- deploy-gh-pages.sh
- skip-all-e2e-tests.sh
- unskip-all-e2e-tests.sh
- .dockerignore
- .editorconfig
- .eslintignore
- .eslintrc
- .gitignore
- .npmrc
- .nvmrc
- .prettierignore
- .prettierrc
- .releaserc
- commitlint.config.js
- cypress.json
- dangerfile.js
- docker-compose.e2e.yml
- Dockerfile.e2e
- LICENSE.md
- package.json
- README.md
- renovate.json
- yarn.lock
# Installation Guide
1. Get the code
git clone https://github.com/brainhubeu/react-carousel
Downloads the entire project code from GitHub to your computer.
cd react-carousel
Moves into the project folder you just downloaded.
2. Docker
Easy RecommendedPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose -f docker-compose.e2e.yml up -d --build
Runs the command against the services defined in the compose file.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
3. Node.js
EasyPrerequisites
npm i @brainhubeu/react-carousel
Type this command into your terminal and run it.
npm i @types/brainhubeu__react-carousel -D
Type this command into your terminal and run it.
yarn test:unit:coverage
Type this command into your terminal and run it.
yarn test:e2e
Type this command into your terminal and run it.
After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
Pulled directly from this repo's README.
// repository documentation
Was this content helpful?
(0 ratings)