ShigotoForm is a project designed to help job seekers, students, and career changers easily and quickly create professional PDF resumes and streamline the job application process. With an intuitive interface and no technical skills required, users can build a professional-quality resume efficiently. All user data is stored locally in the browser and never transmitted to any servers, ensuring maximum privacy. Saved resume data can be exported and imported as JSON files for easy backup or transfer.
This README provides an overview of the project, setup instructions, and contribution guidelines.
- Security & Privacy
- Installation
- Usage
- Screenshots
- Technology choices
- Performance Metrics
- Accessibility Compliance
- Contributing
- License
- Client-side only: No data transmission to external servers
- Local storage: All data remains in your browser
- Privacy-first: Designed with personal data protection in mind
- Future enhancement: Local encryption planned for additional security
To install ShigotoForm, follow these steps:
-
Clone the repository:
git clone https://github.com/yourusername/ShigotoForm.git
-
Navigate to the project directory:
cd ShigotoForm -
Install the necessary dependencies:
npm install
To start using ShigotoForm, run the following command:
npm startThis will start the application on http://localhost:3000.
- Full Name: Enter your full name in the text box. Furigana will be auto-filled to some extent.
- Date of Birth: Select a date from the calendar or enter it in YYYY/MM/DD format.
- Address: Enter your postal code for auto-completion. Please enter the detailed address manually.
- Phone Number: Enter numbers in half-width digits without hyphens.
- Email Address: Enter a valid email address format.
- Education/Work History: Enter your educational and work history in a list format. You can add or remove rows using the "Add" or "Delete" buttons.
- Qualifications/Licenses: Enter your qualifications and licenses in a list format. You can add or remove rows using the "Add" or "Delete" buttons.
You can export the entered resume information to a JSON file or import a previously exported JSON file.
Open the menu from the hamburger button at the top right and click the "Export" or "Import" button.
When exporting, a JSON file will be downloaded.
When importing, select a JSON file from your device and the input screen will be updated immediately.
The content entered on the input screen can be previewed in A4 paper size.
At this time, you can select either Gothic or Mincho font.
By clicking the "Download Resume PDF" button at the bottom right of the preview screen, you can download the preview content as a PDF.
- Input Screen:
- Menu:
- Preview (Gothic Font):
- Preview (Mincho Font):
- Larger storage capacity for resume data
- Better async handling with Promise-based API
- TypeScript integration for type safety
- Client-side processing (no server required)
- High-quality Japanese font rendering
- Customizable PDF layout control
Tested on: 2025-08-11 using Google PageSpeed Insights
WAVE Accessibility Evaluation Results:
- ✅ 0 Errors - No accessibility violations detected
- ✅ 0 Contrast Errors - All text meets WCAG color contrast requirements
⚠️ 2 Alerts - Minor suggestions for enhancement- 🎯 1 Feature - Accessibility features properly implemented
Tested with WAVE Web Accessibility Evaluator on 2025-08-11
We welcome contributions to ShigotoForm! To contribute, follow these steps:
-
Fork the repository.
-
Create a new branch:
git checkout -b feature-branch
-
Make your changes and commit them:
git commit -m "Description of changes" -
Push to the branch:
git push origin feature-branch
-
Create a pull request.
- React + TypeScript migration
- Enhanced accessibility testing
This project is licensed under the MIT License. See the LICENSE file for details.