/snapcv

Primary LanguageTypeScriptGNU Affero General Public License v3.0AGPL-3.0

SnapCV

SnapCV is an open-source, AI-powered platform that effortlessly transforms resumes into professional portfolios. Whether you're a student, coder, or professional, SnapCV makes it easy to showcase your skills and achievements.

Features

  • AI-Driven Portfolio Creation: Upload your resume, and let our AI generate a polished portfolio for you.
  • Custom Subdomains: Get your portfolio hosted on a custom domain like name.snapcv.me.
  • User-Friendly: Built with modern web technologies to ensure a smooth and intuitive user experience.
  • Customization: Modify and tweak your portfolio to fit your personal brand.
  • Open Source: Contribute to the project, report issues, and help make SnapCV even better.

Tech Stack

SnapCV is built using:

  • Next.js: A powerful React framework for building server-rendered applications.
  • Tailwind CSS: A utility-first CSS framework for creating responsive and customizable designs.
  • Supabase: An open-source Firebase alternative for managing the database and authentication.

Getting Started

To get a local copy up and running, follow these steps:

Prerequisites

  • Node.js and npm installed on your machine.
  • Supabase account for database management.

Installation

  1. Clone the repository:
    git clone https://github.com/jamaljm/snapcv.git
    cd snapcv
  2. Install dependencies:
    npm install
  3. Set up environment variables:

    Create a .env.local file in the root directory and add the following:

    NEXT_PUBLIC_SUPABASE_URL=your-supabase-url
    NEXT_PUBLIC_SUPABASE_ANON_KEY=your-supabase-anon-key
    NEXT_PUBLIC_BACKEND=backend-link
  4. Run the development server:
    npm run dev

    Open http://localhost:3000 to view the app in your browser.

Contributing

We welcome contributions from the community! If you'd like to add a new feature or fix a bug, please follow these steps:

  1. Fork the repository to your own GitHub account.
  2. Create a new branch for your feature or bugfix.
  3. Make your changes and commit them with clear messages.
  4. Push your branch to your forked repository.
  5. Open a pull request to merge your changes into the main repository.

Reporting Issues

If you encounter any bugs or have suggestions for new features, please open an issue in the Issues section of the repository. Be sure to include detailed information so we can help resolve it quickly.

Contact

For any questions, feel free to reach out via the email us at jamalvga2002@gmail.com.