https://github.com/epicweb-dev/workshop-template
A template for EpicWeb.dev workshops
https://github.com/epicweb-dev/workshop-template
Last synced: 2 months ago
JSON representation
A template for EpicWeb.dev workshops
- Host: GitHub
- URL: https://github.com/epicweb-dev/workshop-template
- Owner: epicweb-dev
- License: other
- Created: 2023-07-10T20:23:47.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-11T12:01:53.000Z (4 months ago)
- Last Synced: 2025-04-01T10:35:48.350Z (3 months ago)
- Language: JavaScript
- Size: 3.01 MB
- Stars: 14
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
[![Build Status][build-badge]][build]
[![GPL 3.0 License][license-badge]][license]
[![Code of Conduct][coc-badge]][coc]
## Prerequisites
- TODO: add prerequisites
- Some
- Pre-requisite
- links
- here
## Pre-workshop Resources
Here are some resources you can read before taking the workshop to get you up to
speed on some of the tools and concepts we'll be covering:
- TODO: add resources
## System Requirements
- [git][git] v2.18 or greater
- [NodeJS][node] v18 or greater
- [npm][npm] v8 or greater
All of these must be available in your `PATH`. To verify things are set up
properly, you can run this:
```shell
git --version
node --version
npm --version
```
If you have trouble with any of these, learn more about the PATH environment
variable and how to fix it here for [windows][win-path] or
[mac/linux][mac-path].
## Setup
This is a pretty large project (it's actually many apps in one) so it can take
several minutes to get everything set up the first time. Please have a strong
network connection before running the setup and grab a snack.
> **Warning**: This repo is _very_ large. Make sure you have a good internet
> connection before you start the setup process. The instructions below use
> `--depth` to limit the amount you download, but if you have a slow connection,
> or you pay for bandwidth, you may want to find a place with a better
> connection.
Follow these steps to get this set up:
```sh nonumber
git clone --depth 1 https://github.com/epicweb-dev/workshop-template.git
cd workshop-template
npm run setup
```
If you experience errors here, please open [an issue][issue] with as many
details as you can offer.
## The Workshop App
Learn all about the workshop app on the
[Epic Web Getting Started Guide](https://www.epicweb.dev/get-started).
[](https://www.epicweb.dev/get-started)
[npm]: https://www.npmjs.com/
[node]: https://nodejs.org
[git]: https://git-scm.com/
[build-badge]: https://img.shields.io/github/actions/workflow/status/epicweb-dev/workshop-template/validate.yml?branch=main&logo=github&style=flat-square
[build]: https://github.com/epicweb-dev/workshop-template/actions?query=workflow%3Avalidate
[license-badge]: https://img.shields.io/badge/license-GPL%203.0%20License-blue.svg?style=flat-square
[license]: https://github.com/epicweb-dev/workshop-template/blob/main/LICENSE
[coc-badge]: https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square
[coc]: https://kentcdodds.com/conduct
[win-path]: https://www.howtogeek.com/118594/how-to-edit-your-system-path-for-easy-command-line-access/
[mac-path]: http://stackoverflow.com/a/24322978/971592
[issue]: https://github.com/epicweb-dev/workshop-template/issues/new