Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sprblm/dots-website
https://github.com/sprblm/dots-website
Last synced: 5 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/sprblm/dots-website
- Owner: sprblm
- License: cc0-1.0
- Created: 2020-03-11T13:15:06.000Z (over 4 years ago)
- Default Branch: develop
- Last Pushed: 2023-01-27T03:32:06.000Z (almost 2 years ago)
- Last Synced: 2024-09-19T03:38:26.671Z (about 2 months ago)
- Language: JavaScript
- Size: 18.2 MB
- Stars: 16
- Watchers: 6
- Forks: 4
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - sprblm/dots-website - (others)
README
# Decentral Patterns Website
This repository holds the sources for the [decentpatterns.xyz](https://decentpatterns.xyz) website. It's built using the static site generator Eleventy, the tailwindcss framework and Javascript.
## Installation and development
First, make sure that you have initialized and updated the `dots-patterns` submodule.
```
git submodule update --init
```
The site is developed for Node v12, you can use `nvm use` to load the specific version from `.nvmrc` or install it yourselves. Now you can pull the dependencies.
```
npm install
```
To start the development server, run the `npm start` command in terminal and open [`localhost:3000`](http://localhost:3000/). The development server is configured to automatically reload when you make changes.
We use prettier and eslint to maintain a consistent and maintainable code style. Use the npm commands `npm run lint` to validate sources and `npm run prettier` to reformat sources on disk.
## Folder Structure
### Content
The `site` folder contains all the templates, partials and content - which Eleventy will parse into HTML for us. Within our `site` folder, lives a `globals` folder. Here you'll find a `site.json` file - for general config stuff e.g site name, author, email, social media links etc. You'll also find a `navigation.json` file, which we use to loop over in our nav partial to generate our navigation. It's possible to hide navigation entries from the production deployment by setting `"draft": true` on them. There's also a `helpers.js` file, which just contains a simple environment helper.
The repository [dots-patterns](https://github.com/simplysecure/dots-patterns) contains markdown-formatted patterns that are included in the site. The repository contents are symlinked into the folders `site/library` and `site/topics`.
### Assets
Some of the assets are bundled using Webpack. This includes client-side Javascript, which you can find in the `scripts` folder and SCSS stylesheets, which are in the `styles` folder.
Other assets are copied as-is for deployment. This includes fonts in `styles/fonts`, images in `images` and downloadable files in the `public` folder.
### Tooling
The repository root contains configuration files for the various tools we use. In addition, you will find the more elaborate config for 11ty in the `11ty` folder.
## Ready to deploy?
Type the `npm run build` command to minify scripts, styles and run Purgecss.
Purge will cross reference your templates/HTML with all those Tailwind classes and will remove any classes you haven't used - pretty cool huh?