Skip to content

Commit 4ecbfdd

Browse files
committed
prepping for deploy
1 parent 59dcb93 commit 4ecbfdd

File tree

3 files changed

+127
-38
lines changed

3 files changed

+127
-38
lines changed

.github/workflows/deploy.yml

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: Deploy to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
workflow_dispatch:
8+
9+
permissions:
10+
contents: read
11+
pages: write
12+
id-token: write
13+
14+
concurrency:
15+
group: pages
16+
cancel-in-progress: true
17+
18+
jobs:
19+
build:
20+
runs-on: ubuntu-latest
21+
steps:
22+
- name: Checkout repository
23+
uses: actions/checkout@v4
24+
25+
- name: Setup Node.js
26+
uses: actions/setup-node@v4
27+
with:
28+
node-version: 20
29+
cache: npm
30+
31+
- name: Install dependencies
32+
run: npm ci
33+
34+
- name: Build site
35+
run: npm run build
36+
37+
- name: Upload artifact
38+
uses: actions/upload-pages-artifact@v3
39+
with:
40+
path: dist
41+
42+
deploy:
43+
needs: build
44+
runs-on: ubuntu-latest
45+
environment:
46+
name: github-pages
47+
url: ${{ steps.deployment.outputs.page_url }}
48+
steps:
49+
- name: Deploy to GitHub Pages
50+
id: deployment
51+
uses: actions/deploy-pages@v4

README.md

Lines changed: 74 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,83 @@
1-
# Astro Starter Kit: Basics
1+
# Kyoto Tech Meetup Website
22

3-
```sh
4-
npm create astro@latest -- --template basics
5-
```
3+
This repository holds the Astro-powered marketing site for the Kyoto Tech Meetup community.
4+
5+
Everything here is maintained by community members; contributions that make the experience clearer, more accessible, or easier to maintain are welcome.
6+
7+
## Tech Stack
8+
9+
- [Astro 5](https://astro.build/) with React islands for dynamic UI.
10+
- [Tailwind CSS 4 (via `@tailwindcss/vite`)](https://tailwindcss.com/) for utility-first styling plus a small layer of global CSS.
11+
- [Marked](https://marked.js.org/) for rendering Markdown copy inside Astro components.
12+
- ESLint (flat config), TypeScript, Knip, and Astro Check keep the project tidy.
13+
14+
## Getting Started
15+
16+
1. Install dependencies:
17+
18+
```bash
19+
npm install
20+
```
21+
22+
2. Start the local dev server:
23+
24+
```bash
25+
npm run dev
26+
```
27+
28+
Visit `http://localhost:4321` to view the site. Astro enables hot module replacement, so edits appear immediately.
629

7-
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
8-
9-
## 🚀 Project Structure
10-
11-
Inside of your Astro project, you'll see the following folders and files:
12-
13-
```text
14-
/
15-
├── public/
16-
│ └── favicon.svg
17-
├── src
18-
│   ├── assets
19-
│   │   └── astro.svg
20-
│   ├── components
21-
│   │   └── Welcome.astro
22-
│   ├── layouts
23-
│   │   └── Layout.astro
24-
│   └── pages
25-
│   └── index.astro
26-
└── package.json
30+
3. Build for production:
31+
32+
```bash
33+
npm run build
34+
npm run preview
35+
```
36+
37+
## Useful Scripts
38+
39+
| Command | Purpose |
40+
| ------------------ | ----------------------------------------------------------------------- |
41+
| `npm run dev` | Launches Astro in development mode. |
42+
| `npm run check` | Runs lint, type-check, Astro check, and Knip in sequence. |
43+
| `npm run preview` | Serves the production build locally. |
44+
| `npm run build` | Produces the static site in `dist/`. |
45+
46+
47+
## Project Structure
48+
49+
```
50+
src/
51+
├─ pages/ # Astro pages (currently the main landing page)
52+
├─ layouts/ # Shared shells and metadata
53+
├─ components/ # Reusable sections (WhyJoin, WhatWeDo, etc.)
54+
├─ styles/ # Global CSS entry point and Tailwind import
55+
└─ assets/ # Static assets bundled by Astro
56+
public/ # Files served as-is (favicon, images)
2757
```
2858

29-
To learn more about the folder structure of an Astro project, refer to [our guide on project structure](https://docs.astro.build/en/basics/project-structure/).
59+
## Contributing
60+
61+
1. Fork or clone the repo and create a feature branch.
62+
2. Make your changes with clear, accessible copy. Favor data-driven component props when adding new sections.
63+
3. Run `npm run check` before opening a pull request to ensure lint, type, and Astro diagnostics all pass.
64+
4. Describe what you changed and, if applicable, attach screenshots of UI updates for quicker reviews.
65+
66+
## Ideas for Contributions
3067

31-
## 🧞 Commands
68+
- Expand homepage content (additional recurring events, partner highlights, FAQs).
69+
- Build an email newsletter signup form.
70+
- Improve accessibility (ARIA labeling, color contrast, keyboard navigation checks).
71+
- Add tests or visual regression tooling for future redesigns.
72+
- Internationalization or localization improvements for Japanese/English visitors.
3273

33-
All commands are run from the root of the project, from a terminal:
74+
## Interacting with the community
3475

35-
| Command | Action |
36-
| :------------------------ | :----------------------------------------------- |
37-
| `npm install` | Installs dependencies |
38-
| `npm run dev` | Starts local dev server at `localhost:4321` |
39-
| `npm run build` | Build your production site to `./dist/` |
40-
| `npm run preview` | Preview your build locally, before deploying |
41-
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
42-
| `npm run astro -- --help` | Get help using the Astro CLI |
76+
- **Want to report a bug or suggest a feature?**
77+
- [Open an issue on GitHub](https://github.com/kyoto-tech/site/issues).
78+
- **Need help getting started?**
79+
- [Join the Kyoto Tech Meetup Discord](https://discord.gg/mXFWEHDKeu).
4380

44-
## 👀 Want to learn more?
81+
---
4582

46-
Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).
83+
Thanks for helping keep Kyoto’s tech community visible!

astro.config.mjs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,10 @@ import mdx from "@astrojs/mdx";
88

99
// https://astro.build/config
1010
export default defineConfig({
11+
site: "https://kyoto-tech.github.io",
1112
integrations: [react(), sitemap(), mdx()],
1213

1314
vite: {
1415
plugins: [tailwindcss()]
1516
}
16-
});
17+
});

0 commit comments

Comments
 (0)