Skip to content

Commit f21bf68

Browse files
committed
Update README
1 parent 374c0ed commit f21bf68

File tree

1 file changed

+49
-32
lines changed

1 file changed

+49
-32
lines changed

README.md

Lines changed: 49 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,37 @@
1-
# 🚀 UI XNET
1+
# 🚀 UI XNET — Astrojs Playground
22

3-
<img src="lighthouse-score.png" align="right"
4-
alt="AstroWind Lighthouse Score" width="100" height="358">
53

6-
**Oopen-source template** using **Astro** and Tailwind CSS**.
7-
Ready to start a new project and designed taking into account best practices.
4+
**Open-source template** using **Astrojs v4** and **Tailwind CSS v4**.
85

9-
## Features
6+
Playground with content from Homelab—Digital Nomad.
7+
8+
[🌀 gigamaster.github.io/xnet](https://gigamaster.github.io/xnet/)
109

11-
- ✅ Integration with **Tailwind CSS** ([@astrojs/tailwind](https://docs.astro.build/en/guides/integrations-guide/tailwind/)).
12-
- ✅ Supports **Dark mode**.
13-
-**Fast and SEO friendly blog** with automatic **RSS feed** ([@astrojs/rss](https://docs.astro.build/en/guides/rss/)).
14-
-**Image optimization** ([astro:assets](https://docs.astro.build/en/guides/assets/) with Sharp by default).
15-
- ✅ Generation of **project sitemap** based on your routes ([@astrojs/sitemap](https://docs.astro.build/en/guides/integrations-guide/sitemap/)).
16-
-**Open Graph tags** for social media sharing
17-
-**Fonts optimization** at build time ([subfont](https://www.npmjs.com/package/subfont)).
18-
-**Production-ready** scores in [Lighthouse](https://web.dev/measure/) and [PageSpeed Insights](https://pagespeed.web.dev/) reports
19-
-**Modern Astro v3** with improved performance and features
2010

2111
<br>
2212

2313
<img src="./screenshot.jpg" alt="Xnet Homelab - Digital Sovereignty">
2414

2515
<br>
2616

27-
## Site
17+
## Features
2818

29-
[🌀 uixnet.netlify.app](https://uixnet.netlify.app/)
19+
-**Astro v4** with improved performance and features
20+
- ✅ Integration with **Tailwind CSS** ([@astrojs/tailwind](https://docs.astro.build/en/guides/integrations-guide/tailwind/)).
21+
- ✅ Supports **Dark mode**.
22+
-**IconLocal** inline svg workaround to Sharp.
23+
-**Icon src from Inocify**.
24+
-**Image optimization** ([astro:assets](https://docs.astro.build/en/guides/assets/) with Sharp by default).
25+
-**Open Graph tags** for social media sharing
26+
-**Fonts optimization** at build time ([subfont](https://www.npmjs.com/package/subfont)).
27+
-**Production-ready** scores in [Lighthouse](https://web.dev/measure/) and [PageSpeed Insights](https://pagespeed.web.dev/)
28+
-**GitHub Pages** deploy (pnpm or github workflow)
3029

31-
<br>
30+
Commented out due to build issues:
3231

32+
> [!CAUTION]
33+
> Commented out due to build issues: **Fast and SEO friendly blog** with automatic **RSS feed** ([@astrojs/rss](https://docs.astro.build/en/guides/rss/)).
34+
> Generation of **project sitemap** based on your routes ([@astrojs/sitemap](https://docs.astro.build/en/guides/integrations-guide/sitemap/)).
3335
3436
## Getting started
3537

@@ -84,13 +86,11 @@ Folders and files:
8486

8587
Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
8688

87-
There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
89+
Components are used for page's hero and re-usable elements `src/components/` (CardSmall, CardLink, IconLocal, Thumb, etc.)
8890

89-
Any static assets, like images, can be placed in the `public/` directory if they do not require any transformation or in the `assets/` directory if they are imported directly.
9091

91-
[![Edit on CodeSandbox](https://codesandbox.io/static/img/play-codesandbox.svg)](https://githubbox.com/gigamaster/xnet/tree/main)
92-
93-
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
92+
> [!TIP]
93+
> Any static assets, like images, can be placed in the `public/` directory if they do not require any transformation or in the `assets/` directory if they are imported directly.
9494
9595
<br>
9696

@@ -104,6 +104,17 @@ All commands are run from the root of the project, from a terminal:
104104
| `npm run dev` | Starts local dev server at `localhost:3000` |
105105
| `npm run build` | Build your production site to `./dist/` |
106106
| `npm run preview` | Preview your build locally, before deploying |
107+
| `npm run preview` | Deploy to Github PAges |
108+
109+
PNPM
110+
111+
| Command | Action |
112+
| :---------------- | :------------------------------------------- |
113+
| `pnpm install` | Installs dependencies |
114+
| `pnpm dev` | Starts local dev server at `localhost:3000` |
115+
| `pnpm build` | Build your production site to `./dist/` |
116+
| `pnpm preview` | Preview your build locally, before deploying |
117+
| `pnpm deploy` | Deploy to Github PAges |
107118

108119
<br>
109120

@@ -114,9 +125,9 @@ Basic configuration file: `./src/config.mjs`
114125
```javascript
115126
export const SITE = {
116127
name: "Example",
117-
118-
origin: "https://example.com",
119-
basePathname: "/", // Change this if you need to deploy to Github Pages, for example
128+
129+
origin: "https://example.com", // Change this deploy to Github Pages: UserName.github.io
130+
basePathname: "/", // deploy to Github Pages: /RepoName
120131

121132
title: "Example - This is the homepage title of Example",
122133
description: "This is the homepage description of Example",
@@ -165,15 +176,20 @@ You can create an optimized production build with:
165176
npm run build
166177
```
167178

168-
Now, your website is ready to be deployed. All generated files are located at
169-
`dist` folder, which you can deploy the folder to any hosting service you
170-
prefer.
179+
However GitHub workflows/deploy.yml uses PNPM
180+
Node 20 to avoid depndencies conflict Linux/Windows
171181

172-
#### Deploy to Netlify
182+
```shell
183+
pnpm build
184+
```
173185

174-
Clone this repository on own GitHub account and deploy to Netlify:
186+
Now, your website is ready to be deployed. All generated files are located at
187+
`dist` folder, which you can deploy the folder to any hosting service you
188+
prefer. Or use `deploy` for GitHub Pages `gh-pages -d dist -t true `
175189

176-
[![Netlify Deploy button](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/gigamaster/xnet)
190+
```shell
191+
pnpm deploy
192+
```
177193

178194
#### Deploy to Vercel
179195

@@ -204,6 +220,7 @@ Clone this repository on own GitHub account and deploy to Vercel:
204220
- Centralized Styling
205221
Global icon sizing and color are now managed via `.local-icon` svg in base.css
206222
allowing for easy Tailwind integration while maintaining clean SVG source files.
223+
- Removed Netlify ( free tier too limited for a static site)
207224
- *SEO*:
208225
- Support SEO meta-tags (title, description, canonical, social sharing, ...)
209226
- *Blog*:

0 commit comments

Comments
 (0)