Skip to content

Latest commit

 

History

History
207 lines (141 loc) · 9.19 KB

README.md

File metadata and controls

207 lines (141 loc) · 9.19 KB

Portfolio Social Preview

Canvas template

Canvas Portfolio is a fully customizable i18n portfolio template built with Nuxt and Nuxt UI, designed to help you showcase your work, testimonials, and key information with ease. The template integrates with Nuxt Studio for a smooth editing experience, while leveraging Nuxt Content for content management. Built with performance, flexibility, and responsiveness in mind, Canvas Portfolio provides a robust foundation for developers and creatives alike.

Demo

You can see a live demo at canvas.hrcd.fr.

Features

  • Modern Components & Layouts – Includes built-in components.
  • Nuxt UI v3 – Utilize pre-built, customizable UI components.
  • NuxtHub ready - Deploy on NuxtHub in seconds.
  • Tailwind CSS – A beautiful, responsive design system.
  • Working Contact Form – Integrated with Resend for easy email handling.
  • Multi-language Support – Powered by Nuxt i18n.
  • SEO-Ready – Open Graph Image (Nuxt OG Image) & Nuxt Robots for automatic robots.txt generation.
  • Good practices – Auto-generated sitemap, optimized images (Nuxt Image), and ESLint (Nuxt config with Flat config).
  • Fully Responsive – Adapts to all modern browsers and devices.
  • Minimal & Professional Design – Clean, elegant, and easy to customize.

Quick Setup

  1. Clone this repository if you have access or download it from the store
git clone [email protected]:HugoRCD/canvas.git
  1. Install dependencies
pnpm install
  1. Copy the .env.example file to .env and fill in the values
cp .env.example .env
  1. Start development server
pnpm dev
  1. Generate static project
pnpm generate
  1. Start production server
pnpm start

Deployments

Canvas Portfolio is designed to simplify the deployment process on various platforms, whether serverless or not. Below are several detailed methods to deploy your portfolio.

1. Serverless Platforms (Vercel, Netlify, etc.)

When using serverless platforms, it's important to note that Nuxt Content v3 relies by default on SQLite for content storage. Since these platforms do not support SQLite natively, we recommend connecting Canvas Portfolio to an external database such as:

  • PostgreSQL
  • Turso
  • D1

For further details on this process and the suitable solutions for serverless deployments, refer to the official Nuxt Content documentation:
Nuxt Content and Serverless Deployment

Vercel deployment do not need any extra configuration.

Deploy with Vercel

2. Deployment on Nuxthub

Nuxthub offers a powerful solution to deploy your portfolio in just a few clicks. With fast global delivery through the Cloudflare network, Nuxthub also provides advanced features such as:

  • KV storage for optimized data management
  • High-performance caching to reduce loading times
  • Integration of AI tools and analytics for performance improvements

Check out the official Nuxthub documentation for more info.

NuxtHub deployment do not need any extra configuration.

Deploy to NuxtHub

3. Deployment via Docker

Canvas Portfolio is also available as a Docker image, making it easy to deploy in containerized environments. An official Docker image is automatically created using a GitHub workflow whenever a new release is made, or it can be triggered manually.

This workflow not only builds the official Canvas image but also provides a standard way for anyone who forks the project to create their own Docker image with a proper version tag (e.g., v2.0, v1.0.0, etc.).

To pull the latest Docker image:

docker pull ghcr.io/hugorcd/canvas:latest

You can also use Docker Compose for a quick deployment. A community-provided docker-compose.community.yml file is available and can be used with platforms like Coolify for one-click deployments.

How to Modify the Portfolio Content

This portfolio uses Nuxt Content 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.articles 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 Markdown files for each article. To modify an article, simply open its Markdown file and make your changes.
  3. To add a new project, add a new JSON file in this directory.

Featured Works

To change the featured works on the homepage, simply add the "featured": true key the JSON file.

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 to handle the contact form, but it's not mandatory. The server handle will not be used if you don't set the NUXT_PRIVATE_RESEND_API_KEY environment variable.

To set it up, follow these steps:

  • Get your api key from Resend here your api key
  • 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!

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 specification.
  6. If your changes affect the code, run tests using bun run test.
  7. Create a pull request following the Pull Request Template.
    • 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
  • Enable Corepack using corepack enable
  • Install dependencies using bun install
  • Start development server using bun dev
  • Open http://localhost:3000 in your browser

Published under the APACHE license. Made by @HugoRCD and community 💛

🤖 auto updated with automd (last updated: Mon Feb 10 2025)