Skip to content

MarcTimperley/carousel

Repository files navigation

JavaScript Style Guide pipeline status coverage report

carousel

Browse images from a folder in an innovative way by laying them out in a stack and browsing directly to any of them

Demo

A demonstration of the application can be found here. This is configured using a GitLab pipeline on commit to serve to the GitLab pages.

Getting Started

  1. Clone the project
  2. Configure the image source path
  3. Serve the html file

Prerequisites

What things you need to install the software and how to install them

Give examples

Installing

A step by step series of examples that tell you how to get a development env running

Say what the step will be

Give the example

And repeat

until finished

End with an example of getting some data out of the system or using it for a little demo

Running the tests

Explain how to run the automated tests for this system

Break down into end to end tests

Explain what these tests test and why

Give an example

And coding style tests

Explain what these tests test and why

Give an example

Deployment

Add additional notes about how to deploy this on a live system

Contributing and Code of Conduct

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning.

Authors

  • Marc Timperley - Initial work

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

About

Browse images from a folder in an innovative way

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •