Skip to content

Commit 8b372e8

Browse files
committed
docs: comprehensive update to README for next.js app router architecture
1 parent 8df1d1a commit 8b372e8

1 file changed

Lines changed: 46 additions & 1 deletion

File tree

README.md

Lines changed: 46 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,46 @@
1-
NetSepio
1+
# NetSepio Website
2+
3+
The official website for **NetSepio**, revolutionizing internet privacy by providing secure, decentralized VPN (dVPN) and AI-driven networking built to ensure zero single-point-of-failure.
4+
5+
## 🚀 Tech Stack
6+
7+
This project was recently migrated from Create React App to a modern static **Next.js** architecture, featuring advanced UI/UX modernization.
8+
9+
- **Framework**: [Next.js](https://nextjs.org/) (App Router)
10+
- **Styling**: Vanilla [Tailwind CSS](https://tailwindcss.com/)
11+
- **Animations**: [Framer Motion](https://www.framer.com/motion/)
12+
- **Interactive Backgrounds**: [tsParticles](https://particles.js.org/)
13+
- **Package Manager**: [pnpm](https://pnpm.io/)
14+
15+
## ✨ Key Features
16+
17+
- **Decentralized Aesthetics**: Modern dark theme with vibrant cyan and green brand gradients.
18+
- **Advanced UI Interactions**:
19+
- Mouse-reactive dynamic particle constellation networks.
20+
- Hacker-style "Decrypt Sequence" text scramble effects on headlines.
21+
- Subtle cinematic film grain overlay applied globally.
22+
- Sleek glassmorphism (`.glass`, `.glass-card`) overlapping elements.
23+
- **Statically Exported**: Configured as a fully static SPA (`output: 'export'`) for seamless decentralised and static web hosting.
24+
25+
## 🛠️ Getting Started
26+
27+
### Prerequisites
28+
Make sure you have Node.js and `pnpm` (version 10+) installed.
29+
30+
```bash
31+
# Install dependencies
32+
pnpm install
33+
34+
# Start the local development server at http://localhost:3000
35+
pnpm dev
36+
```
37+
38+
### Building for Production
39+
```bash
40+
# Outputs static files to the /out directory
41+
pnpm build
42+
```
43+
44+
## 🌐 Deployment
45+
46+
This project utilizes GitHub Actions (`.github/workflows/deploy.yml`) to automatically build and deploy the statically exported `out` directory to **GitHub Pages** whenever changes are pushed to the `main` branch.

0 commit comments

Comments
 (0)