---

Table of Contents

• Introduction
• Setting Up A Local Build
• For Production
  • Frontend
  • Backend
    • To test the dockerfile locally
• Contributions
• License

---

Introduction

My personal portfolio, but better this time.

It replaced bikatr7.github.io, with a more professional, modern, and frankly not terrible design.

Built with React, Vite, and Typescript

---

Setting Up A Local Build

These steps must be followed in order.

1. Clone the repo, make sure you are using the correct branch (currently production)
2. Navigate to the backend directory. cd backend. Inside is the python backend.
3. Run the setup script with the local argument. This will install all requirements and setup the local env python setup.py local.
4. Run the server. For local uvicorn main:app --reload --port 5000
5. Open a new terminal and navigate to the frontend directory. cd frontend. Inside is the react (vite) frontend.
6. First install all required packages using pnpm. Run pnpm install. Then start the dev server with pnpm dev
7. Website will be on localhost:5173 (frontend) and localhost:5000 (backend)

Default login is admin:password

Also requires a totp code, default is JBSWY3DPEHPK3PXP so use that.

8. To serve the built site locally, use pnpm preview or simply pnpm start (alias).

---

For Production

Frontend

Frontend is hosted on cloudflare pages. To deploy, push to the production branch. Development branch is for development only, intermediate builds deploy every commit.

Backend

For production, the backend is hosted via a dockerfile.

To test the dockerfile locally

1. docker build -t kadenbilyeu.com -f build.dockerfile .
2. docker run -p 8000:8000 kadenbilyeu.com

---

Contributions

I welcome contributions to my site and corrections to any inaccuracies found on the site. Please feel free to fork the repository, make changes, and submit a pull request.

---

License

This site (kadenbilyeu.com) is licensed under the GNU Affero General Public License (AGPLv3). You can find the full text of the license in the LICENSE file.

The AGPLv3 is a copyleft license that promotes the principles of open-source software. It ensures that any derivative works based on this project, as well as any software that interacts with users over a network, must also be distributed under the same AGPLv3 license. This license grants you the freedom to use, modify, and distribute the software.

Please note that this information is a brief summary of the AGPLv3. For a detailed understanding of your rights and obligations under this license, please refer to the full license text.