Skip to content

Repository files navigation

Civy 🚀

Build Your Career. Design Your Future.

Project Status License Platform

🚀 Project Overview

Civy is a mobile-first web application designed to streamline the resume creation process. It empowers job seekers to create professional, visually appealing CVs and Resumes directly from their smartphones, ensuring they stand out in the competitive job market.

🎯 Why Civy?

Creating a properly formatted CV on a mobile device can be frustrating. Civy solves this by providing:

  • Mobile-Optimized Interface: Build your CV anywhere, anytime.
  • Professional Formatting: No design skills needed.
  • Freemium Access: High-quality basic templates for everyone.

✨ Key Features

  • 📱 Mobile-First Design: The UI is fully optimized for a smooth experience on mobile devices.
  • 📄 Smart PDF Export: Generate high-quality, print-ready PDFs with a single click.
  • 🎨 Real-time Preview: See your changes instantly as you fill out the forms.
  • 🔒 Privacy Focused: User data is processed locally, ensuring privacy and security.
  • 💎 Freemium Model: * Free: Access to clean, standard templates.
    • Premium: Unlock advanced, industry-specific designs (Coming Soon).

🗺️ Future Roadmap

We are constantly working to improve Civy. Here is what's coming next:

  • Multi-Language Support: Adding support for Sinhala and Tamil languages.
  • AI Assistance: AI-powered suggestions for writing better summaries and descriptions.
  • Cloud Sync: User accounts to save and access CVs across multiple devices.

🛠️ Tech Stack

Component Technology
Frontend React.js / Next.js
Styling Tailwind CSS (For responsive UI)
State Mgmt Context API / Redux Toolkit
PDF Engine jspdf / react-pdf
Version Control Git & GitHub

🏗️ Installation & Setup

Follow these steps to set up the project locally.

Prerequisites

  • Node.js (v16 or higher)
  • npm or yarn
  • Git

Steps

  1. Clone the repository

    git clone [https://github.com/MevinuMethdam/Civy.git]
    cd civy
  2. Install dependencies

    npm install
  3. Start the development server

    npm run dev

👩‍💻 Git Workflow

We follow a structured Gitflow strategy to ensure code quality.

  1. main: Production-ready code.
  2. develop: The active development branch.
  3. feature/*: New branches for specific features.

How to start a new task:

# 1. Switch to develop
git checkout develop

# 2. Create a new feature branch
git checkout -b feature/your-feature-name
>>>>>>> 9f3ce3dcfabcf4f62484a2145778f01751be4026

About

Build your perfect career path with Civy. A dual-language (Sinhala/English) resume builder for the modern job seeker.

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages