Getting Started

Tip

We recommend using serverless hosting platforms like Vercel, Cloudflare Pages, or Netlify. They are free, easy to use, and provide automatic deployments when you push changes to your repository.

Tip

Already have a CV or portfolio? You can easily migrate it to Devsync! In most cases, you won’t need to rewrite everything manually. Just use the Devsync Skill and let AI handle the conversion for you.

This guide will help you get started with Devsync. Follow the steps below to create your portfolio, resume, GitHub profile, LinkedIn profile, and academic sections all at once.

1. Initialize a project using Devsync:

   bunx @jannael/devsync init

2. Create a repository with your username (example using the GitHub CLI):

   gh repo create [username]/[username] --public

3. Add a remote origin:

   git remote add origin https://github.com/[username]/[username].git

4. Push your project:

   git push -u origin main

5. Fill DEVSYNC.json with your information.

6. Push your changes.

Now you can update DEVSYNC.json to refresh your portfolio, resume, GitHub profile, LinkedIn profile, and academic sections simultaneously, whenever you want.

Tips

• DEVSYNC.json is flexible; you can remove fields you don’t need, and they will be omitted from the output. Note that the behavior of omitted fields depends on the specific template you are using.