|
1 | | -# UK LAN Techs Website |
| 1 | +# 🫖 The TEA Stack |
2 | 2 |
|
3 | | -## Introduction |
| 3 | +Welcome to the most minimal stack out there. This stack makes static site generation a breeze. |
4 | 4 |
|
5 | | -This is the website for UK LAN Techs. It is intended to be built as a Docker image and is from the maintained Ubuntu/Apache/PHP image provided by 1&1 Internet. |
| 5 | +## 🧰 Tools |
6 | 6 |
|
7 | | -## Prerequisites |
| 7 | +This project uses the following frameworks: |
8 | 8 |
|
9 | | -This website is built using Hugo. Please install [hugo](https://gohugo.io) for local development. |
| 9 | +- [TailwindCSS](https://tailwindcss.com/) |
| 10 | +- [Eleventy](https://www.11ty.dev/) |
| 11 | +- [Alpine.js](https://alpinejs.dev/) |
| 12 | +- [Vite](https://vitejs.dev) |
10 | 13 |
|
11 | | -## Building the site |
| 14 | +## ⭐️ Requirements |
12 | 15 |
|
13 | | -The site will be built and deployed automatically when a version is pushed to master. |
| 16 | +- [Node](https://nodejs.org/en/) |
| 17 | +- [NVM](https://github.com/nvm-sh/nvm) |
14 | 18 |
|
15 | | -## Live Build Status |
| 19 | +## 🛠 Getting Started |
16 | 20 |
|
17 | | -The resulting docker image will be built automatically and be seen at (https://hub.docker.com/r/uklans/website/) |
| 21 | +- `nvm use` to switch to the valid node version (`nvm` will grab the correct version found in `.nvmrc`) |
| 22 | +- `npm i` to build that big ol' `node_modules` folder |
| 23 | +- `npm run dev` to boot up a live-reloading dev server |
| 24 | +- `npm run build` to build your production-ready site |
18 | 25 |
|
19 | | -## Adding a new member page |
| 26 | +Feel free to peep the `package.json` file to see all available scripts and packages being utilized. |
20 | 27 |
|
21 | | -If you are a member of UKLans and wish to add your information to the website please follow the instructions below |
22 | | -* Fork this repository |
23 | | -* Add yourself to the members list in hugo/content/sections/members.md |
24 | | -* Create a new file in hugo/content/members/yourlan.md |
25 | | -* Look at the [StratLAN](https://raw.githubusercontent.com/uklans/website/master/hugo/content/members/stratlan.md) / [epic.LAN](https://raw.githubusercontent.com/uklans/website/master/hugo/content/members/epiclan.md) pages for a good format |
26 | | -* Create a pull request |
| 28 | +## ➕ Adding a member |
| 29 | +- Add your logo to `./public/<your-lan-here>.png` |
| 30 | +- Add/Update your LAN in `./src/_data/members.js` |
| 31 | + - Please use single quotes in the JSON (`'`) |
| 32 | +- Done! |
27 | 33 |
|
28 | | -## Issues and Feedback |
| 34 | +### 🔥 Tip: |
29 | 35 |
|
30 | | -Please raise all issues and feedback on GitHub at [uklans/website](https://github.com/uklans/website/issues). |
| 36 | +Running `npm run build && npx serve dist` will boot up a local server of your production site to preview before deployment. |
31 | 37 |
|
32 | | -## License |
| 38 | +### 👋🏻 Thank you! |
33 | 39 |
|
34 | | -The MIT License (MIT) |
35 | | - |
36 | | -Copyright (c) 2017 UK LAN Techs |
37 | | - |
38 | | -Permission is hereby granted, free of charge, to any person obtaining a copy |
39 | | -of this software and associated documentation files (the "Software"), to deal |
40 | | -in the Software without restriction, including without limitation the rights |
41 | | -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
42 | | -copies of the Software, and to permit persons to whom the Software is |
43 | | -furnished to do so, subject to the following conditions: |
44 | | - |
45 | | -The above copyright notice and this permission notice shall be included in all |
46 | | -copies or substantial portions of the Software. |
47 | | - |
48 | | -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
49 | | -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
50 | | -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
51 | | -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
52 | | -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
53 | | -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
54 | | -SOFTWARE. |
| 40 | +I appreciate you taking time to check out the TEA stack, Please leave a star and share it if you found it useful! |
0 commit comments