This repository contains source code of the my website. To view the website, visit wonj.me.
- Next.js for frontend framework
- Tailwind CSS for styling
- Vercel for continuous deployment
- Wagmi for Web3 functionality
To ensure efficient workflow and seamless integration with Vercel for automatic deployment, we follow a specific branching strategy:
-
main
: This is the production branch and is automatically deployed to Vercel. It contains the latest stable version of the website. -
develop
: Our primary development branch. All new features and changes are merged into this branch. Once the development is complete, we create a pull request to mergedevelop
intomain
. -
feature/*
: For new features and significant changes, we create feature branches fromdevelop
. Once development is completed, the feature branch is merged back intodevelop
. (Not strictly followed)
Before starting, ensure you have the following installed:
To set up the project locally, run the following command:
$ npm install
This installs all the necessary dependencies defined in package.json
.
For local development, start the development server with:
$ npm dev run
This command serves your project on a local server with hot reloading. You can view the website at https://localhost:3000
.
To ensure code consistency and detect style issues, run:
$ npm run prettier
This command formats your code according to the rules defined in .prettierrc
.
To create a production-ready build of the project, use:
$ npm run build
This script builds the application for production usage.
This website is automatically deployed to Vercel upon commits to the main
branch.
.
├── app # Next.js application
│ ├── api # API routes
│ └── [pages] # Pages
├── components # React components
├── public # Static files
├── data # Data files
│ └── [pages] # Data for pages
├── config # Configuration javascript files
├── utils # Utility functions
├── assets # Assets not used in the website
├── .github # GitHub workflows
└── [configs] # Configuration files
This project is licensed under the CC BY-SA 4.0 License - see the LICENSE file for details.