Skip to content

Commit 0dae4ba

Browse files
committed
push to main to deploy to Github pages
Signed-off-by: JSONthrytship <[email protected]>
1 parent 47f7171 commit 0dae4ba

File tree

12 files changed

+2690
-1
lines changed

12 files changed

+2690
-1
lines changed

.github/workflows/deploy.yml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: Deploy to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main # or master, depending on your default branch
7+
8+
jobs:
9+
build-and-deploy:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- name: Checkout
13+
uses: actions/checkout@v3
14+
15+
- name: Setup Node.js
16+
uses: actions/setup-node@v3
17+
with:
18+
node-version: '18'
19+
20+
- name: Install Dependencies
21+
run: npm install
22+
23+
- name: Build SASS
24+
run: |
25+
npm run sass:build
26+
27+
- name: Deploy to GitHub Pages
28+
uses: JamesIves/github-pages-deploy-action@v4
29+
with:
30+
folder: public
31+
branch: gh-pages

README.md

Lines changed: 71 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,71 @@
1-
# json-grid-garden
1+
# Semester Portfolio
2+
3+
A portfolio website showcasing 12 weeks of projects, built with Node.js, Express, and SASS.
4+
5+
## Features
6+
7+
- Modern, responsive design
8+
- SASS-based styling
9+
- Weekly project showcases
10+
- GitHub Pages deployment
11+
12+
## Development
13+
14+
1. Clone the repository:
15+
```bash
16+
git clone https://github.com/JSONRice/json-grid-garden.git
17+
cd json-grid-garden
18+
```
19+
20+
2. Install dependencies:
21+
```bash
22+
npm install
23+
```
24+
25+
3. Start the development server:
26+
```bash
27+
npm run dev:all
28+
```
29+
30+
The site will be available at `http://localhost:3000`
31+
32+
## Project Structure
33+
34+
```
35+
public/
36+
├── styles/
37+
│ └── main.scss # Global styles
38+
├── weeks/
39+
│ ├── week1/
40+
│ │ ├── index.html # Week 1 content
41+
│ │ └── style.scss # Week 1 specific styles
42+
│ ├── week2/
43+
│ └── ...
44+
└── index.html # Main landing page
45+
```
46+
47+
## Deployment
48+
49+
This project is configured for automatic deployment to GitHub Pages. The deployment process is handled by GitHub Actions:
50+
51+
1. Push your changes to the main branch
52+
2. GitHub Actions will automatically:
53+
- Install dependencies
54+
- Build SASS files
55+
- Deploy to the gh-pages branch
56+
57+
The site will be available at `https://jsonrice
58+
.github.io/json-grid-garden/`
59+
60+
## Adding New Weeks
61+
62+
To add a new week:
63+
64+
1. Create a new directory in `public/weeks/` (e.g., `week2/`)
65+
2. Copy the template from `week1/`
66+
3. Customize the content and styles
67+
4. Update the main page grid with the new week's information
68+
69+
## License
70+
71+
ISC

0 commit comments

Comments
 (0)