Skip to content

Latest commit

Β 

History

History
122 lines (92 loc) Β· 4.51 KB

README.md

File metadata and controls

122 lines (92 loc) Β· 4.51 KB

1chooo.com Home Page

Novel.sh's GitHub repo

πŸ“ AbstractΒ Β β€’Β  ✨ FeatureΒ Β β€’Β  🌏 ContributingΒ Β β€’Β  πŸ“² Contact InfoΒ Β β€’Β  πŸͺͺ LicenseΒ Β β€’Β  πŸ“š Docs

πŸ“ Abstract

Inspired by the codewithsadee/vcard-personal-portfolio, we aim to convert the HTML/CSS template into a React-based project using Next.js Turborepo.

Our goal is to provide a template where users can build their own portfolio and blog by simply modifying the configuration and content without changing the core code. Users will be able to set up their portfolio by updating the config and adding their own posts to the contents folder.

We'll also provide comprehensive documentation, including a user guide, code walkthrough, and thorough test coverage to ensure a smooth experience.

✨ Features

🌏 Contributing

PRs and Issues are welcome! 🫡🏻

Please read the Contributing Guideline for details on our code of conduct, and the process for submitting pull requests to us.

πŸ”© Getting Started

Note

We choose pnpm as our package manager. Make sure you have it installed before running the following commands.

$ git clone git@github.com:1chooo/1chooo.com.git
$ cd 1chooo.com
$ pnpm install

Run the Web App

$ cd apps/web
$ pnpm run dev   # Open http://localhost:3000 with your browser to see the result.

Run the Docs

$ cd apps/docs
$ pnpm run dev   # Open http://localhost:3001 with your browser to see the result.

πŸ“² Contact Info

Hugo ChunHo Lin

πŸ“© E-mail: hugo970217@gmail.com
🧳 Linkedin: Hugo ChunHo Lin
πŸ‘¨πŸ»β€πŸ’» GitHub: 1chooo

πŸͺͺ License

Important

This work is licensed under a Creative Commons Attribution 4.0 International License by Chun-Ho (Hugo) Lin.

  1. You are free to use this code as inspiration.
  2. Please do not copy it directly.
  3. Crediting the author is appreciated.

This software can be modified and reused without restriction. The original license must be included with any copies of this software. If a significant portion of the source code is used, please provide a link back to this repository.

Please remove all of my personal information by running pnpm run delete.

Made with πŸ–€ by @1chooo

↑ Back to Top ↑