78 lines
2.3 KiB
Markdown
78 lines
2.3 KiB
Markdown
# 🚀 Your Personal Web Dev Lab
|
|
|
|
Welcome to your automated web development sandbox! This repository is connected directly to a robotic server. Whenever you push your code here, the server will automatically build your website and put it on the internet.
|
|
|
|
## 🌍 The Two Worlds (Environments)
|
|
|
|
This repository uses **Branches** to decide where your website goes.
|
|
|
|
- 🛠️ **The `dev` branch (Staging):** Pushing to this branch sends your site to [https://builder.pynixworld.com](https://builder.pynixworld.com). This is your playground. Break things, test new colors, and experiment here!
|
|
- 🌟 **The `main` branch (Production):** Pushing to this branch sends your site to [https://www.pynixworld.com](https://www.pynixworld.com). This is your official, live portfolio for the world to see.
|
|
|
|
---
|
|
|
|
## 💻 How to Get Started
|
|
|
|
**1. Clone this repository to your computer**
|
|
|
|
```bash
|
|
git clone [https://git.pynixworld.com/Moody6/node-app-builder-template.git](https://git.pynixworld.com/Moody6/node-app-builder-template.git)
|
|
cd node-app-builder-template
|
|
```
|
|
|
|
**2. Switch to your playground branch**
|
|
Always do your messy work here first!
|
|
|
|
```bash
|
|
git checkout -b dev
|
|
```
|
|
|
|
**3. Install the packages**
|
|
(We recommend `pnpm` because it is super fast!)
|
|
|
|
```bash
|
|
pnpm install
|
|
```
|
|
|
|
**4. Start coding**
|
|
Run the local server to see your changes live on your computer as you type:
|
|
|
|
```bash
|
|
pnpm run dev
|
|
```
|
|
|
|
---
|
|
|
|
## 🚀 How to Put Your Site on the Internet
|
|
|
|
When you are ready to see your site on your actual domain name, just commit and push!
|
|
|
|
**To update the Test Site (`builder.pynixworld.com`):**
|
|
|
|
```bash
|
|
git add .
|
|
git commit -m "Added a cool new button"
|
|
git push origin dev
|
|
```
|
|
|
|
_(Wait about 15 seconds, then refresh your browser!)_
|
|
|
|
**To update the Live Site (`www.pynixworld.com`):**
|
|
When your test site looks perfect, merge your code into the main branch to show the world.
|
|
|
|
```bash
|
|
git checkout main
|
|
git merge dev
|
|
git push origin main
|
|
```
|
|
|
|
---
|
|
|
|
## 🧰 Changing Frameworks?
|
|
|
|
This template is ready for **React, SvelteKit, Vue, or Astro** right out of the box.
|
|
|
|
If you decide to try a different framework like Create React App, Next.js, or SvelteKit, you just need to tell the server which folder to look for.
|
|
|
|
Open `.gitea/workflows/deploy.yaml` and look for the `dist/*` folder to match your new framework (like `build/*` or `out/*`).
|