Skip to content

Pages' simple carousel based on iframes and written in the Elm language.

License

Notifications You must be signed in to change notification settings

DominikJaniec/Carouselm

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

30 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Carouselm

Pages' simple carousel based on iframes and written in the Elm language.


Goal & design

Prepare small application, which could presents a carousel (like a: Bootstrap Carousel) of few pages loaded in to iframes. Show should be done in given order with a few seconds of display. Users can prepare those carousels of pages and share with others.

"Kanban" board at: Carouselm@Trello.

Requirements:

  1. Should be stateless.
    • All information should be stored in the URL, so "show" could be shared by users.
    • There is no requirement for any back-end, just the web server which serves static HTML, JS or CSS for this application.
  2. Should have two sides: edit and show.
    • edit - Allows to edit list of pages or time interval. Also enables way to copy show's URL and just go to show page.
    • show - Just displays Carousel of pages based on data from URL. Also enables way to just go to edit page.
  3. Initial page should move to the empty edit.
    • Also on both sides (edit, show) should be available button to create new show.
  4. State should be stored in the URL.
    • Data will be compressed and represent as Base64.
  5. Mostly written in the Elm.
    • Elm is Haskell for web - could I say that?
    • Because this is a Elm's experiment.
    • I would like to try Elm language.

How to start work on this project:

  1. Install Node JS, via Chocolatey:
  2. Install Elm, via NPM from Node:
  3. To run tests please install:
  4. For a nice work in the VS Code you need:
  5. To run this project just type: $ elm reactor, and then go to: http://localhost:8000/src/Main.elm
  6. To run tests of this project just type: $ elm-test

How this project was prepared:

  1. In some folder with "empty" git repository, just type:
    • $ elm-package install
  2. Then a file: elm-package.json need to be fixed.
    • I've changed fields: version, summary and license.
    • A repository filed is "broken" because it requires the GitHub repository link with only small letters... so it's not so true value there.
    • Also I've added in the: source-directories value: src, where all code source will be stored.
  3. Then was executed: $ elm-test init which prepares sub-project with Test suite.
    • Warning about existing file: .gitignore should be ignored - it tries create file only with an entry: elm-stuff/.

About

Pages' simple carousel based on iframes and written in the Elm language.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published