Skip to content

Commit b92e96c

Browse files
committed
docs: update README
1 parent 2422639 commit b92e96c

File tree

1 file changed

+93
-13
lines changed

1 file changed

+93
-13
lines changed

README.md

Lines changed: 93 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,54 @@
1-
# N0wayBack Team Website
2-
3-
This is the official website for the N0wayBack team, built with Astro framework, showcasing team introduction, member information, and a hall of fame. The website features a cyberpunk terminal-style design that reflects the team's focus on cybersecurity.
1+
<div align="center">
2+
<img src="./src/assets/logo.svg" alt="N0wayBack Logo" width="400" />
3+
4+
# N0wayBack Team Website
5+
6+
<p>A cyberpunk-themed terminal interface for the N0wayBack CTF team</p>
7+
8+
<p>
9+
<a href="https://n0wayback.net">View Live Site</a> •
10+
<a href="#features">Features</a> •
11+
<a href="#tech-stack">Tech Stack</a> •
12+
<a href="#project-structure">Project Structure</a>
13+
</p>
14+
15+
<p>
16+
<img src="https://img.shields.io/badge/Astro-3.x-orange?style=flat-square&logo=astro" alt="Astro 3.x" />
17+
<img src="https://img.shields.io/badge/Tailwind-3.x-blue?style=flat-square&logo=tailwindcss" alt="Tailwind CSS" />
18+
<img src="https://img.shields.io/badge/TypeScript-5.x-blue?style=flat-square&logo=typescript" alt="TypeScript" />
19+
<img src="https://img.shields.io/badge/license-GPL3-green?style=flat-square" alt="GPL3 License" />
20+
<img src="https://img.shields.io/github/actions/workflow/status/N0wayBack/N0wayBack.github.io/astro.yml?branch=main&style=flat-square&logo=github" alt="GitHub Workflow Status" />
21+
<img src="https://img.shields.io/badge/PRs-welcome-brightgreen?style=flat-square" alt="PRs Welcome" />
22+
<img src="https://img.shields.io/badge/cyberpunk-enabled-ff00ff?style=flat-square" alt="Cyberpunk Enabled" />
23+
</p>
24+
</div>
25+
26+
<details>
27+
<summary>📑 Table of Contents</summary>
28+
29+
- [🌐 About](#-about)
30+
- [🌐 Live Website](#-live-website)
31+
- [🎨 Design Features](#-design-features)
32+
- [👨‍💻 Credits](#-credits)
33+
- [🚀 Project Structure](#-project-structure)
34+
- [📝 Features](#-features)
35+
- [🧞 Commands](#-commands)
36+
- [🔧 Tech Stack](#-tech-stack)
37+
- [📱 Responsive Design & Layout](#-responsive-design--layout)
38+
- [🔄 Loading Animation](#-loading-animation)
39+
- [🚀 Deployment](#-deployment)
40+
- [👥 Contributing](#-contributing)
41+
- [📜 License](#-license)
42+
43+
</details>
44+
45+
## 🌐 About
46+
47+
This is the official website for the N0wayBack team, built with Astro framework, showcasing team introduction, member information, and a hall of fame. The website features a cyberpunk terminal-style design with interactive elements and responsive layouts.
448

549
## 🌐 Live Website
650

7-
Visit our website at [https://n0wayback.com](https://n0wayback.com)
51+
Visit our website at [https://n0wayback.net](https://n0wayback.net)
852

953
## 🎨 Design Features
1054

@@ -13,6 +57,8 @@ Visit our website at [https://n0wayback.com](https://n0wayback.com)
1357
- **Dual-Color ASCII Art**: Custom ASCII art with cyan and red color scheme for brand identity
1458
- **Dark Mode Support**: Optimized for both light and dark themes
1559
- **Fully Responsive**: Carefully designed for both desktop and mobile devices
60+
- **Optimized Layout**: Flex-based layout system ensures proper content distribution and footer positioning
61+
- **Dynamic Loading Animation**: Custom loading screen with progress bar enhances user experience
1662

1763
## 👨‍💻 Credits
1864

@@ -23,24 +69,36 @@ Designed and developed by [shenghuo2](https://github.com/shenghuo2)
2369
```text
2470
/
2571
├── public/
26-
│ └── favicon.svg
72+
│ ├── favicon.svg
73+
│ └── assets/
74+
│ └── members/ # Team member avatars
2775
├── src/
28-
│ ├── components/
76+
│ ├── assets/ # Website resources
77+
│ │ ├── logo.svg
78+
│ │ ├── logo-origin.webp
79+
│ │ └── background.svg
80+
│ ├── components/ # Reusable components
2981
│ │ ├── Footer.astro
3082
│ │ ├── MemberCard.astro
31-
│ │ └── Navbar.astro
32-
│ ├── data/
33-
│ │ ├── honors.ts
34-
│ │ └── members.ts
35-
│ ├── layouts/
83+
│ │ ├── Navbar.astro
84+
│ │ └── Welcome.astro
85+
│ ├── data/ # Data files
86+
│ │ ├── honors.ts # Honors and achievements data
87+
│ │ └── members.ts # Team members data
88+
│ ├── layouts/ # Page layouts
89+
│ │ ├── Layout.astro
3690
│ │ └── MainLayout.astro
37-
│ └── pages/
91+
│ └── pages/ # Pages
3892
│ ├── honors.astro
3993
│ ├── index.astro
4094
│ └── members.astro
4195
├── .github/
4296
│ └── workflows/
43-
│ └── astro.yml
97+
│ └── astro.yml # GitHub Pages automated deployment
98+
├── CNAME # Custom domain configuration
99+
├── astro.config.mjs # Astro configuration
100+
├── tailwind.config.js # Tailwind CSS configuration
101+
├── tsconfig.json # TypeScript configuration
44102
└── package.json
45103
```
46104

@@ -50,6 +108,8 @@ Designed and developed by [shenghuo2](https://github.com/shenghuo2)
50108
- **Members Page**: Displays team leaders, active members, and pioneers with their skills and contributions
51109
- **Honors Timeline**: Chronological display of team achievements and milestones in CTF competitions
52110
- **Responsive Design**: Adapts to various device screen sizes with optimized layouts for mobile
111+
- **Optimized Loading Experience**: Progressive loading animations with customized messages for different page types
112+
- **Full-Screen Terminal**: Vertically expanded terminal interface that fills the entire viewport for immersive experience
53113

54114
## 🧞 Commands
55115

@@ -68,6 +128,26 @@ All commands are run from the root of the project:
68128
- [Tailwind CSS](https://tailwindcss.com) - Utility-first CSS framework
69129
- [TypeScript](https://www.typescriptlang.org/) - Typed JavaScript for better code quality
70130

131+
## 📱 Responsive Design & Layout
132+
133+
The website uses a flex-based layout system to ensure proper content distribution across different screen sizes:
134+
135+
- **Flexible Container Layout**: Using flex-grow and flex-direction to optimize space usage
136+
- **Sticky Footer**: Footer is properly positioned at the bottom of the page using mt-auto
137+
- **Full-height Terminal**: Terminal container expands to fill available viewport space
138+
- **Responsive Typography**: Font sizes adjust based on screen width
139+
- **Mobile-Optimized Navigation**: Simplified navigation for smaller screens
140+
141+
## 🔄 Loading Animation
142+
143+
The website features a sophisticated loading animation system:
144+
145+
- **Progress Bar**: Visual indication of page loading progress
146+
- **Custom Loading Messages**: Different messages based on page type (index, members, honors)
147+
- **Smooth Transitions**: Fade-in effects for content after loading completes
148+
- **Terminal Boot Effect**: Simulates a terminal boot sequence for an authentic cyberpunk experience
149+
- **Optimized Performance**: Loading animations are designed to be lightweight and non-blocking
150+
71151
## 🚀 Deployment
72152

73153
The website is automatically deployed to GitHub Pages using GitHub Actions. The deployment workflow is defined in `.github/workflows/astro.yml`. When changes are pushed to the main branch, the site is automatically built and deployed.

0 commit comments

Comments
 (0)