Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hugorcd/hr-folio
My personnal minimal but beautiful portfolio made with Nuxt 3, Nuxt Content and TailwindCSS
https://github.com/hugorcd/hr-folio
minimal nuxt nuxt-content portfolio resend responsive tailwindcss typescript
Last synced: about 2 months ago
JSON representation
My personnal minimal but beautiful portfolio made with Nuxt 3, Nuxt Content and TailwindCSS
- Host: GitHub
- URL: https://github.com/hugorcd/hr-folio
- Owner: HugoRCD
- License: apache-2.0
- Created: 2024-01-22T20:03:57.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-10-16T07:36:15.000Z (2 months ago)
- Last Synced: 2024-10-17T22:32:31.435Z (2 months ago)
- Topics: minimal, nuxt, nuxt-content, portfolio, resend, responsive, tailwindcss, typescript
- Language: Vue
- Homepage: https://hrcd.fr
- Size: 12.3 MB
- Stars: 9
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/funding.yml
- License: LICENSE
Awesome Lists containing this project
README
# HR Folio
This is the code for my personal portfolio built with [Nuxt](https://nuxt.com/) and [Tailwind CSS](https://tailwindcss.com/).
## Live website
You can see it live at [hrcd.fr](https://hrcd.fr/).
## Features
- Fully integrated with [Nuxt Content](https://content.nuxt.com/) and using the content driven mode.
- Working contact form with [Resend](https://resend.com/)
- Article & Project Content Type using [Nuxt Content](https://content.nuxt.com/)
- Open Graph Image support with [Nuxt OG Image](https://nuxtseo.com/og-image/getting-started/installation)
- [Nuxt Robots](https://sitemap.nuxt.com/) for auto-generate robots.txt
- [ESLint](https://eslint.org/) using my personal configuration
- Full typescript support
- Optimized images with [Nuxt Image](https://image.nuxt.com/)
- [Vue Composition Collection (Vueuse)](https://vueuse.org/)
- Fully responsive on all modern browsers
- Easy to customize
- Auto generated sitemap
## Quick Setup
1. Clone this repository if you have access or download it from the store
```bash
git clone [email protected]:HugoRCD/hr-folio.git
```
2. Install dependencies
```bash
bun install
```
3. Start development server
```bash
bun dev
```
4. Generate static project
```bash
bun generate
```
5. Start production server
```bash
bun start
```
## How to Modify the Portfolio Content
This portfolio uses [Nuxt Content](https://content.nuxt.com/) to manage the content. Here's how you can modify it:
First check the `app.config.ts` file to change the global configuration of the portfolio, there is a lot of stuff you can change here.
### Writing
1. Navigate to the `content/2.writing` directory.
2. Here, you'll find Markdown files for each article. To modify an article, simply open its Markdown file and make your changes.
3. To add a new article, create a new Markdown file in this directory. The name of the file will be used as the URL slug for the article.
### Works
1. Navigate to the `content/1.works/` directory.
2. Here, you'll find JSON files for each project. To modify an project, simply open its JSON file and make your changes.
3. To add a new project, add a new JSON file in this directory.
### Other Content
Simply go to the `content/` directory and edit any of the Markdown or JSON files to modify the content.
## Setup the Contact Form
This portfolio uses [Resend](https://resend.com/) to handle the contact form. To set it up, follow these steps:
- Get your api key from [Resend](https://resend.com/) here [your api key](https://resend.com/api-keys)
- Add your api key in the `.env` file
- change the `from` key in the `sendEmail` route in the `server/api/` folder, you can customize everything you want in this route
- That's it, you're good to go!
## Setup the Open Graph Image
To change the main open graph image, go to the `app.config.ts` file and change the `openGrapImage` key.
## Contributing
To start contributing, you can follow these steps:
1. First raise an issue to discuss the changes you would like to make.
2. Fork the repository.
3. Create a branch using conventional commits and the issue number as the branch name. For example, `feat/123` or `fix/456`.
4. Make changes following the local development steps.
5. Commit your changes following the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.
6. If your changes affect the code, run tests using `bun run test`.
7. Create a pull request following the [Pull Request Template](https://github.com/HugoRCD/markdown/blob/main/src/pull_request_template.md).
- To be merged, the pull request must pass the tests/workflow and have at least one approval.
- If your changes affect the documentation, make sure to update it.
- If your changes affect the code, make sure to update the tests.
8. Wait for the maintainers to review your pull request.
9. Once approved, the pull request will be merged in the next release !
Local development
- Clone this repository
- Install latest LTS version of [Node.js](https://nodejs.org/en/)
- Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable`
- Install dependencies using `bun install`
- Start development server using `bun dev`
- Open [http://localhost:3000](http://localhost:3000) in your browser
Published under the [APACHE](https://github.com/HugoRCD/hr-folio/blob/main/LICENSE) license.
Made by [@HugoRCD](https://github.com/HugoRCD) and [community](https://github.com/HugoRCD/hr-folio/graphs/contributors) 💛
---
_🤖 auto updated with [automd](https://automd.unjs.io) (last updated: Tue Jun 18 2024)_