Job application tracker and AI-powered job search assistant. Helps job seekers manage their search journey with AI resume review, job matching, task logging, and application analytics, all while keeping your data private.
TypeScript ai-agentai-resume-analyzerapplication-trackerapplication-tracking-systematscareerjob-applicationjob-automationjob-huntingjob-searchjob-seeker-toolsjob-trackerjob-trackingjobsearchjobseekersmcpollamaresumeresume-reviewself-hosted
Update readme
Khuram Niazae15fdf2ac80
diff --git a/README.md b/README.mdindex 4f63aef..1b6c3c1 100644--- a/README.md+++ b/README.md@@ -1,43 +1,50 @@-This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).+# JobSync - Job Search Assistant-## Getting Started+## <a href="https://demo.jobsync.ca" target="_blank">Live Demo</a>-First, run the development server:+JobSync is a web app companion for managing your job search journey. This free and open-source project is designed to help job seekers efficiently track and organize their job applications. Say goodbye to the chaos of scattered information and hello to a streamlined, intuitive, and powerful job search experience.-```bash-npm run dev-# or-yarn dev-# or-pnpm dev-# or-bun dev-```+Job searching can be overwhelming, with numerous applications to track and deadlines to meet. JobSeeker Assistant is here to simplify this process, allowing you to focus on what really matters: landing your dream job. JobSync app platform empowers you with the tools you need to stay organized, informed, and proactive throughout your job search.++## Key Features+- **Application Tracker:** Keep a detailed record of all your job applications, including company details, job titles, application dates, and current status.++- **Activity Monitoring Dashboard:** Visualize your job search progress with an interactive dashboard that provides insights into your application activities, success rates, and upcoming tasks.++- **Document Management (Coming Soon!):** Store and manage your resumes, cover letters, and other application-related documents in one convenient place.++- **AI Assistant (Coming Soon!):** Leverage the power of AI to improve your resumes and cover letters. Get personalized job matching with scoring to identify the best opportunities tailored to your profile.-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.-You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.+## Free to Use and Self-Hosted+JobSync Assistant is completely free to use and open source. Our commitment to providing a powerful job search management tool at no cost ensures that everyone has access to the resources they need. Additionally, JobSeeker Assistant is designed to be self-hosted, giving you full control over your data. By using Docker, you can easily set up and run JobSync Assistant on your own server, ensuring a secure and personalized experience.-This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.-## Learn More+## Installation-To learn more about Next.js, take a look at the following resources:+### Using Docker-- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.-- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.+#### Step 1 - Clone repo+* **Alternativey you can also download the source code using download link**-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!+```sh+git clone https://github.com/Gsync/jobsync.git+```-## Deploy on Vercel+#### Step 2 (Optional) - Change environment variables+* **Alternativey you can also download the source code using download link**++#### 2.1 Generate auth secret (Optional)-The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.+These methods will generate a random string that you can use as your AUTH_SECRET. Make sure to set this in your environment variables:-Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.+For example, add it to your .env local file:-## Generate auth secret+```sh+AUTH_SECRET="your_generated_secret"+```-### For npm+##### For npm```shnpm exec auth secret@@ -47,16 +54,34 @@ ORnpx auth secret```-### Using the openssl command available on Linux and Mac OS X:+##### Using the openssl command available on Linux and Mac OS X:```shopenssl rand -base64 33```-These methods will generate a random string that you can use as your AUTH_SECRET. Make sure to set this in your environment variables:+#### 2.2 Change username and password (Optional)-For example, add it to your .env local file:+You can use default username (admin@example) and password (password123) or change it in the Dockerfile++#### Step 3 - Build docker image and run container+* **Please make sure you have <a href="https://www.docker.com">docker</a> installed, you dont need to know docker to be able to run the following command**+* Please make sure you are in the root folder```sh-AUTH_SECRET="your_generated_secret"-```\ No newline at end of file+docker compose up+```++#### Step 4 - Access the app+* **Open [http://localhost:3000](http://localhost:3000) with your browser to access the app.**+* If you encounter port conflicts, please change it in the docker file++### Thanks to the following libraries to make it easy to build apps++- <a href="https://github.com/facebook/react" target="_blank">React</a>+- <a href="https://github.com/vercel/next.js" target="_blank">Next</a>+- <a href="https://github.com/shadcn-ui/ui" target="_blank">Shadcn</a>+- <a href="https://github.com/tailwindlabs/tailwindcss" target="_blank">Tailwind</a>+- <a href="https://github.com/ueberdosis/tiptap" target="_blank">Tiptap</a>+- <a href="https://github.com/plouc/nivo" target="_blank">Nivo</a>+- <a href="https://github.com/sqlite/sqlite" target="_blank">Sqlite</a>