Skip to content

0xwonj/wonj.eth

Repository files navigation

banner-img

wonj.eth

This repository contains source code of the my website. To view the website, visit wonj.me.

license-badge language-badge tag-badge issues-badge

Technologies

Branches

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 merge develop into main.

  • feature/*: For new features and significant changes, we create feature branches from develop. Once development is completed, the feature branch is merged back into develop. (Not strictly followed)

Project Setup

Prerequisites

Before starting, ensure you have the following installed:

  • Node.js: JavaScript runtime
  • npm: Package manager for JavaScript
  • Git: Version control system

Installation

To set up the project locally, run the following command:

$ npm install

This installs all the necessary dependencies defined in package.json.

Local Development

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.

Linting

To ensure code consistency and detect style issues, run:

$ npm run prettier

This command formats your code according to the rules defined in .prettierrc.

Build

To create a production-ready build of the project, use:

$ npm run build

This script builds the application for production usage.

Deployment

This website is automatically deployed to Vercel upon commits to the main branch.

Project Structure

.
├── 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

License

This project is licensed under the CC BY-SA 4.0 License - see the LICENSE file for details.