Skip to content

Commit

Permalink
📑Clean-up V: packages remove, readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
thienguen committed Aug 25, 2023
1 parent 729ed97 commit 8e8f51a
Show file tree
Hide file tree
Showing 6 changed files with 201 additions and 1,233 deletions.
135 changes: 131 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,56 @@
# Thienguen personal website version 1.0

# Thienguen personal website version 1.0
- Web dev surely is something, now i wonder how backend looks like, will update this lata
- 8/25/2023, this is still in development (maybe)

Web dev surely is something, now i wonder how backend looks like, will update this lata
# Preview

![Something](http://g.recordit.co/C5V1kC86St.gif)

## Getting Started

First, run the development server:
Set up the environment variables file with the following variables.

- Get `GITHUB_ID` and `GITHUB_SECRET` from [Github OAuth](https://docs.github.com/en/developers/apps/building-oauth-apps/creating-an-oauth-app)

- Get `GOOGLE_CLIENT_ID` and `GOOGLE_CLIENT_SECRET` from [Google OAuth](https://console.cloud.google.com/apis/credentials)

- GET `NEXTAUTH_SECRET` from [NextAuth](https://next-auth.js.org/getting-started/example)
- OR runt the command `openssl rand -base64 32` in the CLI
- OR access to this website [NextAuth](https://generate-secret.vercel.app/32)

### .env

```bash
# https://api.lanyard.rest/v1/users/user_id
BASE_URL=http://localhost:3000

NEXT_PUBLIC_DISCORD_ID=
NEXT_PUBLIC_EMAIL=

GITHUB_ID=Iv1.
GITHUB_SECRET=

GOOGLE_CLIENT_ID=
GOOGLE_CLIENT_SECRET=

DATABASE_URL=

NEXTAUTH_URL_INTERNAL=http://10.240.8.16
NEXTAUTH_URL=http://localhost:3000
NEXTAUTH_SECRET=
```

Next, run in the CLI (root folder)

```bash
# install dependencies
npm install

# run prisma CLI
npm prisma run

# run the development server
npm run dev
# or
yarn dev
Expand All @@ -17,5 +60,89 @@ pnpm dev

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
# Features

- [x] Discord Presence
- [x] Google OAuth
- [x] Github OAuth
- [x] Lanyard API
- [x] Guestbook
- [x] Kbar
- [x] useSound
- [x] Blog (TBD)
- [ ] Reponsive (breh)

# Project Folder Structure

Welcome to the project's folder structure! Below is an organized representation of the directories and subdirectories:

```bash
## prisma
├── 📄 schema.prisma

## public
├── 📂 bg
├── 📂 fonts
├── 📂 icons
├── 📂 icons-json
├── 📂 images
├── 📂 mouse
├── 📂 rpg
└── 📂 sounds

## src code
├── 📁 app
│ ├── 📁 about
│ ├── 📁 api
│ ├── 📁 contact
│ ├── 📁 guestbook
│ └── 📁 projects
├── 📁 components
│ ├── 📁 about-me
│ │ └── 📁 qa
│ ├── 📁 common
│ ├── 📁 contact
│ ├── 📁 footer
│ ├── 📁 guestbook
│ ├── 📁 home
│ │ └── 📁 lanyard
│ ├── 📁 navbar
│ └── 📁 purojekuto
│ ├── 📁 (render)
│ │ ├── 📁 many
│ │ └── 📁 one
│ └── 📁 (timeline)
├── 📁 ui
├── 📁 hooks
│ └── 📁 lanyard
└── 📁 lib
├── 📁 nextauth
└── 📁 util

## css
├── 📁 styles
│ ├── 📄 global.css
│ ├── 📄 carousal.css
│ ├── 📄 kbar.css
│ ├── 📄 navbar.css
│ ├── 📄 hi.css
│ ├── 📄 timeline.css
│ └── 📄 activity.css
```

# Tech Stack

- [Next.js](https://nextjs.org/)
- [React.js](https://reactjs.org/)
- [Tailwind CSS](https://tailwindcss.com/)
- [Prisma](https://www.prisma.io/)
- [NextAuth.js](https://next-auth.js.org/)
- [PlanetScale](https://planetscale.com/)


# Issues

The repo currently facing two known bugs from Next.js

- [ ] [Server run out of memory](https://github.com/vercel/next.js/issues/46756)
- [ ] [Non Post Server Error](https://github.com/vercel/next.js/issues/53882)
Loading

0 comments on commit 8e8f51a

Please sign in to comment.