-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
15 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,36 +1,22 @@ | ||
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). | ||
### Resume Scan | ||
|
||
## Getting Started | ||
ResumeOptiML is an open-source web application designed to help users optimize their resumes effectively. Leveraging the powerful open-source language model, Llama2, this tool analyzes uploaded resumes and provides constructive feedback and optimization suggestions tailored to enhance job application success. This project aims to democratize access to career advancement tools by using cutting-edge AI technology in an easy-to-use, accessible format. | ||
|
||
First, run the development server: | ||
### Key Features | ||
|
||
```bash | ||
npm run dev | ||
# or | ||
yarn dev | ||
# or | ||
pnpm dev | ||
# or | ||
bun dev | ||
``` | ||
|
||
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. | ||
|
||
This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font. | ||
- Upload and analyze resumes in multiple formats. | ||
- Real-time feedback and suggestions powered by Llama2. | ||
- User-friendly interface for easy interactions and results interpretation. | ||
|
||
## Learn More | ||
### Installation | ||
|
||
To learn more about Next.js, take a look at the following resources: | ||
|
||
- [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. | ||
|
||
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome! | ||
|
||
## Deploy on Vercel | ||
```Bash | ||
git clone https://github.com/open-xyz/resume-scan | ||
cd resume-scan | ||
npm i | ||
npm run dev | ||
``` | ||
|
||
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. | ||
Contributors are welcome to join the project to expand its capabilities, improve its accuracy, and support a wider range of resume formats and job sectors. | ||
|
||
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details. | ||
Let's make job applications smarter together! |