Vitaes

Introduction · Installation · Tech Stack + Features · Author · Credits · License

Introduction

Vitaes is a free and open-source resume builder. It allows you to create a professional-looking resume with a clean and modern design.

Installation

To install Vitaes, you need to have Bun or npm installed on your system. You can then clone the repository and install the dependencies using the following commands:

git clone https://github.com/diegopluna/vitaes.git
cd vitaes
npm install
# or
yarn install
# or
pnpm install
#or
bun install

Copy .env.example to .env.local and update the variables.

cp .env.example .env.local

Start the development server by running the following command:

npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

This will start the server and make it available at http://localhost:3000.

Tech Stack + Features

Frameworks

• Next.js – React framework for building performant apps with the best developer experience.
• Drizzle ORM: A TypeScript ORM for building database applications.
• Auth.js: A library for authentication and authorization in web applications.
• Puppeteer: A Node.js library that allows you to automate interactions with web browsers.

Plataforms

• Vercel – Easily preview & deploy changes with git
• Neon Database: A PostgreSQL database that provides a robust and scalable solution for storing and managing data.

UI

• Tailwind CSS: A utility-first CSS framework that provides a clean and modern design.
• Shadcn/ui: A React UI library that provides a set of components and utilities for building user interfaces.
• Lucide - A collection of icons that can be used in your React applications.

In addition to these technologies, Vitaes also includes the following features:

• Resume builder: Allows you to create a professional-looking resume with a clean and modern design.
• PDF export: Allows you to export your resume as a PDF file.
• Authentication: Supports Github authentication for easy and secure access to your resume.
• Dark mode: Supports a dark mode for a more comfortable and professional experience.

Authors

• Diego Luna - Initial work - diegopluna
• Arthur Costa - Initial work - Arthurlpgc

Credits

• AwesomeCV - A LaTeX template for creating a professional CV.

Contributing

We love our contributors! Here's how you can contribute:

• Open an issue if you believe you've encountered a bug.
• Make a pull request to add new features/make quality-of-life improvements/fix bugs.

License

Vitaes is licensed under the MIT License. See the LICENSE file for more information.