nicholais-website/README.md

99 lines
2.0 KiB
Markdown

# Nicholai's website
This is my personal website built with Next.js 15, Tailwind CSS, and TypeScript.
## Tech Stack
Next.js 15, Tailwind CSS, Cabin font family, Turbopack, Typescript.
### Prerequisites
- Node.js 18+ installed (node modules: densest thing in the known universe.)
- npm, yarn, pnpm, whatever honestly.
### Installation
1. Clone the repository:
```bash
git clone https://git.biohazardvfx.com/Nicholai/nicholais-website.git
```
2. Install dependencies:
```bash
npm install
```
### Development
Run the development server:
```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
### Pushing to Git and Docker
1. Commit changed files to main branch on gitea
`git add . && git commit -m "added higher res profile image" && git push origin main`
2. Build docker image
`docker build -t git.biohazardvfx.com/nicholai/nicholais-website:latest .`
3. Push docker package to gitea
`docker push git.biohazardvfx.com/nicholai/nicholais-website:latest`
### Building for Production
```bash
npm run build
```
### Deployment
#### Docker Deployment
This project includes a Dockerfile for containerized deployment. To build and run the application using Docker:
1. Build the image:
```bash
docker build -t nicholais-website .
```
2. Run the container:
```bash
docker run -p 3000:3000 nicholais-website
```
3. Or with environment variables:
```bash
docker run -p 3000:3000 -e NODE_ENV=production nicholais-website
```
#### Environment Variables
The application supports the following environment variables:
| Variable | Description | Default |
|----------|-------------|---------|
| `NODE_ENV` | Node.js environment | `development` |
| `PORT` | Port to run the server on | `3000` |
## License
This project is open source, take it. I don't give a fuck. I am not your dad.
## Author
Nicholai - VFX Supervisor & Developer
- Website: [nicholai.work](https://nicholai.work)
- Email: nicholai@biohazardvfx.com
- Instagram: [@nicholai.exe](https://www.instagram.com/nicholai.exe/)