Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/msanvarov/personal-portfolio
🌐 react next.js app for personal portfolio
https://github.com/msanvarov/personal-portfolio
contentful cv nextjs portfolio portfolio-website react starter-template
Last synced: 3 months ago
JSON representation
🌐 react next.js app for personal portfolio
- Host: GitHub
- URL: https://github.com/msanvarov/personal-portfolio
- Owner: msanvarov
- Created: 2019-04-22T01:37:38.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-24T14:22:03.000Z (8 months ago)
- Last Synced: 2024-10-01T03:24:06.856Z (3 months ago)
- Topics: contentful, cv, nextjs, portfolio, portfolio-website, react, starter-template
- Language: SCSS
- Homepage: https://sal-anvarov.com
- Size: 65 MB
- Stars: 45
- Watchers: 2
- Forks: 22
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Sal's Personal Portfolio Website
A modern Next.js portfolio website built with 💙 and ☕ by Sal Anvarov. Deployed with HotJar, GTM, and Formspree tools for analytics and form tracking.
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fmsanvarov%2Fpersonal-portfolio&env=ENABLE_TRACKING,HOTJAR_WEBSITE_UID,HOTJAR_VERSION,GOOGLE_TAG_MANAGER_UID,MICROSOFT_CLARITY_UID,DEBUGBEAR_RUM_UID&envDescription=Environment%20Configs%20for%20Website&envLink=https%3A%2F%2Fgithub.com%2Fmsanvarov%2Fpersonal-portfolio%23-environment-configuration&project-name=personal-portfolio&repository-name=personal-portfolio&redirect-url=https%3A%2F%2Fgithub.com%2Fmsanvarov%2Fpersonal-portfolio&demo-title=Sal's%20Personal%20Website&demo-url=https%3A%2F%2Fwww.sal-anvarov.com&demo-image=https%3A%2F%2Fwww.sal-anvarov.com%2Fassets%2Fthumbnails%2Fwebsite.png)
> Remark: Deploying on Vercel will **FAIL** as **Nx** has the output directory as **dist** on builds by default. To fix this - navigate to the **Build and Development Settings** and change the **Output Directory** to `dist/apps/personal-portfolio/.next`. Documentation: https://vercel.com/docs/deployments/configure-a-build#build-and-development-settings
Table of Contents:
1. [Description](#-description)
2. [Prerequisites](#%EF%B8%8F-prerequisites)
3. [Deployment](#-deployment)
4. [Environment Configuration](#-environment-configuration)
5. [Repository Files and Folders](#-repository-files-and-folders)
6. [Testing](#-testing)
🔎 This repo was created with [Nx](https://nx.dev/).
### 📚 Description
Preview: https://www.sal-anvarov.com/
This portfolio website was built with ease of extensibility in mind. This app comes with **MDX** for case-studies and blog management and **Bootstrap** for styling. The app has redux state management via **Redux Toolkit** and **React Hooks**.
> Remark: Given **App Router** is not fully stable, I opted to stay with **Pages Router** until further notice. The plan is to eventually migrate to **App Router**.
---
### 🛠️ Prerequisites
#### Tracking Tools
- [HotJar](https://www.hotjar.com/)
- [Google Analytics](https://www.marketingplatform.google.com)
- [Microsoft Clarity](https://clarity.microsoft.com)
- [DebugBear RUM](https://www.debugbear.com/docs/rum/real-user-monitoring)
- [Vercel Analytics](https://vercel.com/docs/analytics/quickstart)
#### Non Docker
- Please make sure to have [Node.js](https://nodejs.org/en/download/) (16+) locally by downloading the Javascript runtime via `brew`, `choco`, or `apt-get`.
#### Docker 🐳
- Please make sure to have [Docker Desktop](https://www.docker.com/products/docker-desktop/) operational to quickly compose the required dependencies. Then follow the docker procedure outlined below.
---
### 🚀 Deployment
#### Manual Deployment without Docker
- Clone the repo via `git clone https://github.com/msanvarov/personal-portfolio`.
- Navigate to the root directory of repo via `cd personal-portfolio`.
- Download dependencies via `npm i` or `yarn`.
- Create a **.env file** via the `cp apps/personal-portfolio/.env.example .env` command and replace the example environment variables with valid ones.
- Start the app in development mode via `npm run start` (the app will be exposed on http://localhost:4200; not to conflict with the default React, Angular, or Vue ports).
> Remark: In the docker deployment, the UI is automatically started and served by the API.
#### Deploying with Docker 🐳
[Open in Docker Dev Environments 
](https://open.docker.com/dashboard/dev-envs?url=https://github.com/msanvarov/personal-portfolio/tree/master)
- Execute the following command in-app directory:
```bash
# creates and loads the docker container in detached mode with the required configuration
$ docker-compose up -d
```
- The following command will download dependencies and execute the web application on http://localhost:80 (deployed behind a Nginx reverse proxy).
---
### 🔒 Environment Configuration
By default, the application comes with a config module that can read in every environment variable from the `.env` file.
**APP_ENV** - the application environment to execute as, either in development or production. Determines the type of logging options to utilize. Options: `development` or `production`.
**ENABLE_TRACKING** - enables tracking tools. Options: `true` or `false`.
**HOTJAR_WEBSITE_UID** - hotjar website uid, requires a HotJar account (**free**)
**HOTJAR_VERSION** - hotjar version
**GOOGLE_TAG_MANAGER_UID** - google tag manager uid, requires google analytics to be onboarded.
**MICROSOFT_CLARITY_UID** - microsoft clarity uid, manages heatmaps and events. requires a Microsoft account (**free**)
> Remark: DebugBear can be easy onboarded via [Vercel](https://vercel.com/integrations/debugbear)
**DEBUGBEAR_RUM_UID** - debugbear real user monitoring (RUM) uid, requires DebugBear to be onboarded (**free**).
---
### 📁 Repository Files and Folders
```text
.
├── Dockerfile
├── README.md
├── apps
│ ├── personal-portfolio
│ │ ├── case-studies
│ │ ├── index.d.ts
│ │ ├── jest.config.ts
│ │ ├── next-env.d.ts
│ │ ├── next.config.js
│ │ ├── pages
│ │ ├── posts
│ │ ├── project.json
│ │ ├── public
│ │ ├── tests
│ │ ├── tsconfig.json
│ │ ├── tsconfig.spec.json
│ │ └── utils
│ └── personal-portfolio-e2e
│ ├── cypress.config.ts
│ ├── project.json
│ ├── src
│ └── tsconfig.json
├── assets
│ └── open-link.svg
├── compose.yaml
├── dist
│ └── apps
│ └── personal-portfolio
├── jest.config.ts
├── jest.preset.js
├── libs
│ ├── core-components
│ │ ├── README.md
│ │ ├── project.json
│ │ ├── src
│ │ ├── tsconfig.json
│ │ └── tsconfig.lib.json
│ └── store
│ ├── README.md
│ ├── project.json
│ ├── src
│ ├── tsconfig.json
│ └── tsconfig.lib.json
├── nx.json
├── package-lock.json
├── package.json
├── tools
│ └── tsconfig.tools.json
└── tsconfig.base.json
```
---
### ✅ Testing
#### Docker 🐳
```bash
# Start the docker container if it's not running
$ docker start frontend
# unit tests
$ docker exec -it frontend npm run test
```
#### Non-Docker
```bash
# execute test
$ npm run test
```
---
### 🏗️ Progress
| Branches | Status |
| ------------------------------------------------------------------: | :----- |
| [main](https://github.com/msanvarov/personal-portfolio) | ✅ |
| [feat/\*](https://github.com/msanvarov/personal-portfolio/branches) | 🚧 |
---
### 👥 Help
PRs are appreciated, I fully rely on the passion ❤️ of the OS developers.
---
## License
This personal portfolio website is [MIT licensed](LICENSE).
[Author](https://linkedin.com/in/sal-anvarov)