Git Product home page Git Product logo

cevi-tools-webpage's Introduction

Cevi Tools Webpage

This repo contains the content of the cevi.tools webpage. Cevi Tools is a collection of useful tools developed by the Cevi community.

Local Development (using Docker)

You can preview your changes locally using docker. Clone the Repo, install docker and run:

docker compose watch

The preview page can be accessed on http://localhost:4000.

Local Development (with local ruby installation)

  1. Clone the repo to a local folder
  2. Install jekyll following the instructions on the official webpage.
  3. Install your bundles once by running the following commands:
$ bundle config set --local path 'vendor/bundle'
$ bundle install
  1. Serve the webpage locally by running the following command:
$ bundle exec jekyll serve

Deployment

Our webpage gets served directly from the gh-pages branch, which contains the plain HTML and CSS source. Those files are generated automatically upon committing to the main branch by a GitHub-Action script. Therefore, you do not want to commit directly to the gh-pages branch.

For every pull request (to the main branch), GitHub Actions will create a preview such that you can check your changes before releasing them by merging your changes into main.

                       ┌───────────────┐              ┌───────────────┐
                       │               │   merge      │               │
    your code ───────► │  pull request │ ───────────► │  main branch  │
     changes           │               │              │               │
                       └───────┬───────┘              └───────┬───────┘
                               │                              │  
                               │                              │  generates sources
                               │                              │  automatically using
                               ▼                              │  a GitHub-Action script
                                                              │
                      generates a preview                     ▼
                        using Firebase                ┌───────────────┐            ┌──────────────┐
                                                      │               │            │              │
                                                      │    gh pages   │  codebase  │    webpage   │
                                                      │     branch    │    for     │  cevi.tools  │
                                                      │               │ ◄────────► │              │
                                                      └───────────────┘            └──────────────┘

cevi-tools-webpage's People

Contributors

btemperli avatar dependabot[bot] avatar leo1212 avatar maede97 avatar patrickuhlmann avatar thomashaefliger avatar ursforrer avatar wp99cp avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Forkers

btemperli

cevi-tools-webpage's Issues

Design: Project Entry layout

As of now, each project conists of the title, a short description and (at least) one image (claim / header).

We could potentially create an additional layout file for a single "project"? This way, every entry in the webpage would look the same.

Incorporate KuTo

Incorporate the other repository KuTo (Kurs-Tools) into this repo as well.

Design: Header sizes

The title "Online verfügbare Tools" is in markdown a H1, but the font-size is smaller than H2.
We could possibly:

  • remove the h1 element and change the page title (or keep it for Webtools, but change it for "In Entwicklung"?
  • change scss to make h1 bigger.

I like the first option better, what do you think?
image

Landing page has no h1

The main page does not use an h1 title, this is bad praxis and should be changed. At the moment the page title is just a bold text:

---
layout: home
---

**Digitale Tools für Cevi-Lager und Kurse**

Maybe this is related to #7, I haven't tested it yet.

Caching issue

After the deployment of the change ebfab52 the table was still displayed with a width of 800px instead of 1200px (see change in _sass/minima.scss).

Most likely the problem is that the old version of the css was still cached. We should optimize the caching policy to prevent such issues in the future.

Dependabot not working properly

It fails with
Run FirebaseExtended/action-hosting-deploy@v0 /home/runner/work/_actions/FirebaseExtended/action-hosting-deploy/v0/bin/action.min.js:2102 throw new Error(Input required and not supplied: ${name}); ^

The reason can be found in the documentation (https://docs.github.com/en/code-security/dependabot/working-with-dependabot/automating-dependabot-with-github-actions):
When a Dependabot event triggers a workflow, the only secrets available to the workflow are Dependabot secrets. GitHub Actions secrets are not available. Consequently, you must store any secrets that are used by a workflow triggered by Dependabot events as Dependabot secrets.

This affects the following two secrets:

  • GITHUB_TOKEN
  • CEVI_TOOLS_FIREBASE_PREVIEW_TOKEN

They can be added under Settings/Secrets and variables/Dependabot. If we use the same names it should then work. But unfortunately I don't have permission to do so.

@wp99cp can you please do this?

Add App-Selector (Waffle) like M365

Titel "Tools für Abteilungen"

Den Titel "Tools für Abteilungen" finde ich unpassend.
Denn auch der Logo-Generator, eMeal und der MZB-Generator sind Tools für Abteilungen.
Ausserdem haben wir uns bisher darauf beschränkt, bzw. die Premisse gehabt, dass Tools online und "ready to use" sein sollten.
Dies trifft auf die dort vorgestellte API / App / Chästlizettel nicht zu.

Replace build in build with Github Action

It seems the default build is buggy, we need to replace the default build mechanism with a GitHub Action script. Because the default build will add the title of the start page (index.html) to the header nav.

Deployed Version:
Screenshot from 2021-12-09 22-45-13

  • Duplicate h1
  • Unwanted link in header nav

Preview Build:
Screenshot from 2021-12-09 22-47-21

Add Impressum

We should add an Impressum to the page and link it in the footer.

Add existing applications of Cevi Dürnten as shareing for other "groups" (abteilungen)

Hoi zäme

Wir vom Cevi Dürnten haben über die Jahre hinweg eine ganzen Anwendungslandschaft aufgebaut um unsere Cevi "Prozesse".
Dazu gehören eine Mobile App, ein Webinterface, ein "Plugin" für die Webseite sowie eine API, welche all diese Sachen verbinden.

Dazu gehören folgende Features

  • Abfrage vom Chästlizettel und der nächsten Daten auf dem Mobile
  • An- und Abmeldung über die Mobile App
  • Webinterface zum Eintragen der Chästlizettel Informationen sowie Einsicht über die An- und Abmeldungen
  • Automatische Mails bei Eintragungen an die Eltern (über Mailverteiler der cevi.db)
  • API zu Nextcloud zur Abfrage der Kalenderdaten.

Link zum App Store
Link zum Webinterface
Link zur API
Link zu den Repos

Das ganze Konstrukt kann grundsätzlich von jeder Abteilung wiederverwendet werden und so auch in ihrer Abteilung eingesetzt werden. Daher haben wir uns gedacht, könnte man dies vielleicht auch auf eurer "Homepage" teilen.

Wäre dies in eurem Sinn? Oder eher nicht?
Falls ja, würde ich auch die Dokumentation zum Hosting und Co. etwas auf Vordermann bringen, dass dies für fast jeden verständlich wäre.

Change Pictures for QualiTools and App

We should change the pictures for the QualiTools and the App, because we use official J+S pictures and we are (at least at the moment) not an official J+S-Page.

Favicon

Our deployment is missing the Favicon. We should add one (maybe the same as cevi.ch has?)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.