https://github.com/eggsy/website

🧬 Source code of my personal website. Everything is included. Written in NuxtJS, TypeScript and Windi CSS!
https://github.com/eggsy/website

blog discord firebase nuxt portfolio premid tailwind-css typescript vue windi-css

Last synced: about 17 hours ago
JSON representation

🧬 Source code of my personal website. Everything is included. Written in NuxtJS, TypeScript and Windi CSS!

• Host: GitHub
• URL: https://github.com/eggsy/website
• Owner: eggsy
• License: mit
• Created: 2020-07-03T16:01:45.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-08-03T22:08:54.000Z (about 2 months ago)
• Last Synced: 2024-09-22T14:02:27.523Z (3 days ago)
• Topics: blog, discord, firebase, nuxt, portfolio, premid, tailwind-css, typescript, vue, windi-css
• Language: Vue
• Homepage: https://eggsy.xyz
• Size: 24 MB
• Stars: 303
• Watchers: 6
• Forks: 39
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
eggsy.xyz




  





  

  



My personal portfolio website, built with Nuxt.js, Windi CSS, TypeScript and Firebase.

### ✨ Features

Website features many custom built systems, integrations and pages!

- ✅ Projects, experiences, skills, GitHub Repositories, favorite songs, contact pages.

- ✅ Fully static markdown-driven blog with Nuxt Content.

- ✅ Firebase integration.

- ✅ Real-time Discord profile data using [Lanyard API](https://github.com/Phineas/lanyard/).

- ✅ Last.fm API to display top tracks and recently played songs－[example](https://eggsy.xyz/me/songs).

- ✅ Written in TypeScript.

- ✅ Tons of handmade custom components.

### 🔧 Getting Started

You need to install [Node.js](https://nodejs.org/) and [Git](https://git-scm.com/downloads) to your machine. Node.js comes with its own package manager called `npm`, you can either use that or you can use [`pnpm`](https://pnpm.io/installation) since it's faster and caches downloaded dependencies properly.

- Clone the repository with `git clone https://github.com/eggsy/website`

- Install dependencies with your preffered package manager.

  - With pnpm: `pnpm install`

  - With NPM: `npm install`

- If you are going to use Firebase, you'll need to rename `.env.example` to `.env` and fill the config.

  - **P.S.** You can use the website without the Fireabse integration as it requires a bunch of additional steps on its own. Read the title below for more information.

- Start the app:

  - For development:

    - With pnpm: `pnpm dev`

    - With NPM: `npm run dev`

  - To build and compile:

    - With pnpm: `pnpm generate` (or `pnpm build`)

    - With NPM: `npm run generate` or (`npm run build`)

If you are wondering about **how to host it on free/paid static hosting services** like (Netlify, Vercel etc.), you can refer to [Nuxt.js docs](https://nuxtjs.org/deployments/netlify/). My project is hosted on [Netlify](https://netlify.com).

### 🤔 Don't need Firebase?

If you don't want to take the additional steps installing and configuring a Firebase account just to use the website, follow these steps:

1. Remove `firebase` and `@nuxtjs/firebase` modules via your package manager.

2. Remove `@nuxtjs/firebase` from `tsconfig.json`.

3. Remove `firebase` import and the line of `@nuxtjs/firebase` reference in the array in `config/modules.ts` file.

4. Remove `@/plugins/Firebase` reference from the plugins array in `config/plugins.ts` (remove the whole object), and delete that file from `plugins` directory, you don't need it anymore.

5. Delete `config/modules/firebase.ts`.

6. Delete the Daily page: `src/pages/daily.vue`.

   - Delete existing links and references to this page as it might throw errors when building the app.

### 💖 Sponsors