Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/buildit/design-tech-website

Website to promote the Designit + buildit training course for design & tech collaboration
https://github.com/buildit/design-tech-website

css eleventy html website

Last synced: 1 day ago
JSON representation

Website to promote the Designit + buildit training course for design & tech collaboration

Awesome Lists containing this project

README

        

# Design & Tech training course website
[![Netlify Status](https://api.netlify.com/api/v1/badges/4104bed4-bfa3-466d-855c-1d64a7575e26/deploy-status)](https://app.netlify.com/sites/design-tech-training/deploys)

Website to promote the [Designit](https://www.designit.com/) + [Buildit](https://buildit.wiprodigital.com/) training course for design & tech collaboration.

Live URL is: https://design-tech-training.netlify.com/

- [Pre-requisites](#pre-requisites)
- [Initial setup](#initial-setup)
- [Local dev](#local-dev)
- [Where the source code lives](#where-the-source-code-lives)
- [Builds](#builds)
- [Clean](#clean)
- [Deployment](#deployment)

## Pre-requisites

* Node.js & NPM

## Initial setup

1. Clone this repo.
1. (Within the cloned repo) Run: `npm install`.

## Local dev

```sh
npm start
```

This will build the website, launch a local dev server and open the homepage in your default browser. The source files will be watched and any changes will trigger the necessary rebuilds and auto-reload in your browser.

Note: Build output will be placed into the `dist/` folder.

### Where the source code lives
This site uses the [Eleventy](https://www.11ty.io/) static site generator, so refer to its [docs](https://www.11ty.io/docs/) for usage. Eleventy's source directory has been configured to be `src/site/`, so all templates and other files that Eleventy processes live in there.

For styling, we use [SASS](https://sass-lang.com/) and the main SASS source file is: `src/sass/style.scss`. All styling-related changed must be made in that file.

(Note that this file initially gets compiled to `src/site/styles.css` and _then_ copied from the to the final build output folder by Eleventy. Therefore make sure you _never_ edit `src/site/styles.css`, because your changes will get lost next time the SASS is recompiled!)

## Builds
To "just" to a build, e.g. for deployment, without launching a local dev server and watching for changes run:

```sh
npm run build
```

## Clean
To nuke the build output from orbit run:

```sh
npm run clean
```

## Deployment
We currently use a free [Netlify](https://www.netlify.com/) account to host this. Pushes to the `master` branch will trigger rebuilds and deployments.