Repo der offiziellen bits-und-baeume.org Website.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Carsten Knoll e60c008984 Journal-Call: fix pdf-problem 2 months ago
.husky Initial commit 4 months ago
.vscode Initial commit 4 months ago
eleventy Initial commit 4 months ago
public Delete bits-und-baeume-logo.svg 2 months ago
src Journal-Call: fix pdf-problem 2 months ago
.editorconfig Initial commit 4 months ago
.eleventy.js change .eleventy.js to achive valid rel="me" link in the footer 2 months ago
.eslintignore Initial commit 4 months ago
.eslintrc Initial commit 4 months ago
.gitignore clean file names and folder structure 4 months ago
.hintrc Initial commit 4 months ago
.prettierignore Initial commit 4 months ago
.prettierrc Initial commit 4 months ago
LICENSE Initial commit 4 months ago
README.md added an explanation for local use of netlify cms 4 months ago
markdown.js Initial commit 4 months ago
package-lock.json Revert package-lock.json 2 months ago
package.json clean file names and folder structure 4 months ago
postcss.config.js Initial commit 4 months ago
tailwind.config.js Kücheninfos 2 months ago
webpack.common.js fix typo from last commit in webpack config file 4 months ago
webpack.dev.js Initial commit 4 months ago
webpack.html Initial commit 4 months ago
webpack.prod.js Initial commit 4 months ago

README.md

Website - Bits und Bäume 2022

Based on Eleventy Starter Boilerplate

Features

Production-ready in mind:

Requirements

  • Node.js and npm

Getting started

Run the following command on your local environment:

git clone --depth=1 https://github.com/bitsundbaeume/bits-und-baeume.org.git b-und-b
cd b-und-b
npm install && npm run prepare

Local development

You can run locally in development mode with live reload:

npm run dev

Open http://localhost:8080 with your favorite browser to see your blog.

See http://localhost:8080/elemente/ to see all styled design elements.

netlify cms

To open netlify cms locally without need for authentication run

npx netlify-cms-proxy-server

in a second console for local backend.

Then open http://localhost:8080/admin/ to see the admin interface.

Project structure

.
├── public                # Static files
│   └── admin             # Files for netlify cms
│   └── assets
│       └── images        # Images not needed by Webpack (like most svg or gif)
│          └── social     # Social Images used for Social Media via frontmatter "socialimage:"
└── src
    ├── _data             # Eleventy data folder
    ├── _includes
    │   └── layouts       # HTML layout files
    │   └── partials      # template parts
    ├── assets            # Assets folder that needs to be processed by Webpack
    │   ├── images        # Images like jpg, png, jpeg - and all files linked to in CSS files
    │   │   ├── galleries # Images used in galleries
    │   │   └── posts     # Images used in your blog posts (will be compressed by Webpack)
    │   └── styles        # Your blog CSS files
    └── different folders # holding your content

Customization

You can easily change base settings of this boilerplate. Please change the following files:

  • src/_data/site.json: your configuration
  • src/_includes/layouts: your HTML layout
  • src/_includes/partials: change mainmenu or favicons here
  • src/assets/styles/main.css: your CSS file using Tailwind CSS
  • src/elemente.njk: all styled design elements

Testing

Before deploying to production it's a good idea to test the build result by building it locally and run tests against it. At the moment the package.json scripts for testing are not running stable. To test your site please use:

npm run serve

to build and run the website locally.

In another console you can now run tests. For checking all links with broken-link-checker and for tests of performance, accessibility, best practices and security with hint:

blc http://localhost:5000 -ro && hint http://localhost:5000

Deploy to production

You can see the results locally in production mode with:

npm run serve

The generated HTML and CSS files are minified. It will also remove unused CSS from Tailwind CSS.

You can create an optimized production build with:

npm run build

Now, your blog is ready to be deployed. All generated files are located at _site folder, which you can deploy with any hosting service.

License

Even after many changes and further developments by the team of ACB. allcodesarebeautiful we gladly continue to list the copyright of the original boilerplate on which our work is based. This is for legal reasons and out of gratitude for the initial work we could build on.

Licensed under the MIT License, Copyright © 2020

See LICENSE for more information.