Web3CV/README.md

144 lines
3.7 KiB
Markdown

# Personal Website - Chris Wylde
A modern, responsive personal website built with React, TypeScript, and Vite. This project serves as a professional landing page and link aggregator, featuring sections for professional experience, Web3 achievements, NFT collections, and social connections.
## 🚀 Features
- Modern React with TypeScript and Vite
- Responsive design with Tailwind CSS
- Animated sections and transitions
- Dark theme with custom gradients
- Social media integration
- NFT gallery
- Achievement showcase
- Professional experience timeline
## 🛠 Tech Stack
- React 18
- TypeScript
- Vite
- Tailwind CSS
- Lucide Icons
- Recharts for data visualization
## 📦 Installation
**Clone the repository:**
```bash
git clone https://git.boilerhaus.org/boiler/Web3CV.git
cd Web3CV
```
**Install dependencies:**
```bash
npm install
```
**Start the development server:**
```bash
npm run dev
```
**Build for production:**
```bash
npm run build
```
## 🚀 Deployment
This website is deployed on a VPS at [boilerhaus.org](https://boilerhaus.org) using a custom deployment script.
### Deployment Setup
1. **Environment Configuration**
- Create a `.env` file based on `.env.example`
- Add your server credentials:
```
SERVER_USER=your_server_username
SERVER_PASSWORD=your_server_password
SERVER_IP=your_server_ip
```
2. **Deploy to VPS**
- Run the deployment script:
```bash
./deploy-website.sh
```
- This script will:
- Build the project
- Create a tarball of the built files
- Upload to the server
- Extract files to the web directory
- Set proper permissions
3. **Check Website Status**
- Run the status check script:
```bash
./check-website.sh
```
- This will check the status of all services:
- Portfolio website (boilerhaus.org)
- Gitea (git.boilerhaus.org)
- Vaultwarden (bw.boilerhaus.org)
- Nextcloud (cloud.boilerhaus.org)
### Maintenance Scripts
The repository includes several utility scripts to help with maintenance:
1. **update-from-gitea.sh**
- Updates the local repository from Gitea
- Preserves any local changes using git stash
2. **fix-nginx-config.sh**
- Fixes the Nginx configuration on the server
- Properly configures all subdomains
3. **fix-nextcloud-occ.sh**
- Adds cloud.boilerhaus.org to Nextcloud's trusted domains
- Uses the Nextcloud occ command-line tool
4. **cleanup.sh**
- Removes unnecessary files from the repository
- Updates .gitignore to exclude build artifacts
### Server Configuration
The website is served by Nginx with SSL certificates from Let's Encrypt. The configuration files are located on the server at `/etc/nginx/sites-available/`.
## 🌐 Domain Information
### Current Setup
- Domain: [boilerhaus.org](https://boilerhaus.org)
- Subdomains:
- [git.boilerhaus.org](https://git.boilerhaus.org) - Gitea instance
- [bw.boilerhaus.org](https://bw.boilerhaus.org) - Vaultwarden instance
- [cloud.boilerhaus.org](https://cloud.boilerhaus.org) - Nextcloud dashboard
### Previous Setup (Archived)
- Domains: [www.chriswylde.xyz](https://www.chriswylde.xyz) and [www.boilerrat.xyz](https://www.boilerra.xyz)
- Registrar: Namecheap
- Previous Host: Netlify/Vercel
## 🤝 Contributing
Contributions, issues, and feature requests are welcome! Feel free to check the [issues page](https://git.boilerhaus.org/boiler/Web3CV/issues).
## 📝 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## 👤 Contact
- Website: [boilerhaus.org](https://boilerhaus.org)
- Twitter: [@boilerrat](https://twitter.com/boilerrat)
- Farcaster: [@boiler](https://warpcast.com/boiler)
- Email: [128boilerrat@gmail.com](mailto:128boilerrat@gmail.com)