Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/araguaci/timeline-surf-santa-catarina

🚧 working in progress 🚧Linha do Tempo de eventos relacionados ao Surf em Santa Catarina
https://github.com/araguaci/timeline-surf-santa-catarina

json-api time-line-view timeline

Last synced: 2 months ago
JSON representation

🚧 working in progress 🚧Linha do Tempo de eventos relacionados ao Surf em Santa Catarina

Host: GitHub
URL: https://github.com/araguaci/timeline-surf-santa-catarina
Owner: araguaci
License: mit
Created: 2022-03-12T01:28:31.000Z (almost 3 years ago)
Default Branch: main
Last Pushed: 2024-07-24T04:04:31.000Z (6 months ago)
Last Synced: 2024-07-31T19:35:41.645Z (6 months ago)
Topics: json-api, time-line-view, timeline
Language: JavaScript
Homepage: https://timeline-surf-santa-catarina.vercel.app/
Size: 2.26 MB
Stars: 2
Watchers: 3
Forks: 0
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Início do Surf no Brasil

![Linha do tempo do início do surf brazuca](https://hardcore.com.br/wp-content/uploads/sites/21/2022/07/linha-do-tempo-surf-brasileiro-2.jpg)

*hardcore.com.br*

[Fonte...](https://hardcore.com.br/historia-do-surf-brasileiro-descobrimos-a-1-prancha-catarinense-1940/)

# Timeline Surf Santa Catarina

Linha do Tempo de eventos importantes relacionados ao surfe em Santa Catarina.

História da evolução do surfe no estado e Escolas de Surf com o apoio da ACESSC.

  - [Timeline Surf Santa Catarina](https://timeline-surf-santa-catarina.vercel.app/)

  - [working in progress](./TIMELINE.md)

## Escolas de Surf FECEESS / ACESSC

**Unindo talentos e fortalecendo a educação e o esporte em Santa Catarina**

A FEDERAÇÃO CATARINENSE DE ESPECIALISTAS E **ESCOLAS DE SURF E STAND UP PADDLE**, com a sigla FECEESS ou [ACES-SC](https://escolasdesurf.org.br/), é uma associação civil, de direito privado, de âmbito estadual, sem fins lucrativos e/ou econômicos, fundada em 07 de novembro de 2003, com sede e foro na cidade de Florianópolis, na Rodovia João Gualberto Soares, 7145 sala 03, CEP 88.060-000, Rio Vermelho, Florianópolis – SC Estado de Santa Catarina.

Entende-se como Especialista em Surf e Escolas de Surf, escolas de esporte e profissionais especializados em surf e todas as suas extensões, a saber: surf, bodyboard, stand up Paddle, surfe de peito e tow-in, segundo preceitos [ACES-SC](https://escolasdesurf.org.br/) / [FECASURF](http://www.fecasurf.com.br/) / [CREF-SC](https://www.crefsc.org.br/?s=surf).

  - [A.C.E.S. SC](https://escolasdesurf.org.br/)

  - [F.E.C.E.E.S.S.](https://feceess.escolasdesurf.org.br/)

## Static timeline generator

Easily create a static timeline webpage like my [Wikimedia timeline](https://www.mollywhite.net/wikimedia-timeline/).

**Contents**

- [Static timeline generator](#static-timeline-generator)

  - [Install](#install)

  - [Customize](#customize)

    - [Primary content](#primary-content)

    - [Meta](#meta)

  - [Additional customization](#additional-customization)

  - [Responsiveness](#responsiveness)

  - [Browser compatibility](#browser-compatibility)

  - [Under the hood](#under-the-hood)

![Screenshot of a timeline page with dummy content](https://github.com/molly/static-timeline-generator/blob/main/docs/browser.png)

## Install

Clone this repository, then run `npm install` from the directory.

`npm run-script serve` will build the project and serve the static files locally at http://localhost:8080. `npm run-script build` just runs the build step without starting the development server.

## Customize

Almost all of the content you need to change is in `src/_data/content.js`.

### Primary content

- `header` (HTML, optional): The content to display in the header at the top of the page.

- `footer` (HTML, optional): The content to display in the footer at the bottom of the page.

- `entries` (array of objects, **required**): The list of entries to display on the timeline, in the order they should display.

  - `id` (string, **required**): A unique ID for this timeline entry.

  - `categories` (array of strings, optional): A list of categories that apply to this entry. These will show up as checkboxes at the top of the page, and allow readers to filter the timeline. They may not contain commas. They can be hyphen or space separated (`sample category` or `sample-category` will both display on the page as `Sample category`). Entries without any categories will always display.

  - `color` (string, optional): The color of the circle that displays on the timeline line. The options already defined are `green`, `red`, and `grey`. You can define additional colors in `css/custom.css` (see below).

  - `faicon` (string, optional): The name of a Font Awesome icon to use in the circle on the timeline line. [Explore the options](https://fontawesome.com/v5.15/icons?d=gallery&p=2&s=solid&m=free). This is just the icon name (without the `fa-` prefix). For example: `anchor`.

  - `datetime` (string, either `datetime` or `date` must be present): A date and time specifier for the item. This can be in [any format that `moment.js` recognizes](https://momentjs.com/docs/#/parsing/string/). I normally do "YYYY-MM-DD HH-SS". If there is no time, only a date, use the `date` parameter instead of `datetime`.

  - `date` (string, either `datetime` or `date` must be present): A date specifier for the item. "YYYY-MM-DD".

  - `title` (HTML, **required**): The title of the timeline entry.

  - `image` (optional): An image to display in the entry

    - `src` (string, required): A direct URL to the image file to be embedded on the page, or a relative link to an image in this directory (for example `img/filename.png`).

    - `link` (string, optional): A hyperlink to the page containing the image, if you'd like people to be able to click it to see a larger version, etc.

    - `alt` (string, optional): [Alt text](https://supercooldesign.co.uk/blog/how-to-write-good-alt-text) describing the image.

    - `caption` (HTML, optional): A caption describing the image.

  - `body` (HTML, **required**): The text of the timeline entry. If you want multiple paragraphs, you have to include `
` tags yourself; otherwise, it will be added.

  - `links` (array of objects, optional): An array of links to display at the bottom of the entry.

    - `href` (string, **required**): The target of the link.

    - `linkText` (HTML, **required**): Link text.

    - `extra` (HTML, optional): Extra HTML to display at the end of the link.

### Meta

- `pageTitle` (string, **required**): The text to go in the `` tag, to set the title of the page in the browser.

- `pageDescription` (string, optional): Page description to go into [meta](https://www.w3schools.com/tags/tag_meta.asp) tags.

- `pageAuthor` (string, optinal): Page author to go into [meta](https://www.w3schools.com/tags/tag_meta.asp) tags.

## Additional customization

If you would like to add more color options for the circles on the timeline, you can edit the `src/css/custom.css` file to add your own. You can use [this tool](https://htmlcolorcodes.com/) to pick colors and get their hex color codes. They are defined like so:

```css

.timeline-icon.yourcolorhere {

  background-color: #hexcolorcode;

}

```

You would then use `color: yourcolorhere` in the content.js file.

Replace the images in the `src/img` folder to customize the page [favicon](https://blog.hubspot.com/website/what-is-a-favicon) and [OpenGraph image](https://blog.hubspot.com/marketing/open-graph-tags-facebook-twitter-linkedin).

## Responsiveness

Timelines will render well on tablets:



or mobile devices:



## Browser compatibility

This should work well on all modern browsers. IE <9 is not supported.

Without JavaScript enabled, the page degrades gracefully. However, posts will show in a single-column timeline and filters will not show.

## Under the hood

This project uses

- [11ty](https://www.11ty.dev)

- [EJS](https://ejs.co/)

- [moment.js](https://momentjs.com/)

- [FontAwesome](https://fontawesome.com/)

- [normalize.css](https://github.com/necolas/normalize.css)

- [classlist-polyfill](https://github.com/eligrey/classList.js)

It is released under the [MIT license](https://github.com/molly/static-timeline-generator/blob/main/LICENSE).