A react application which helps in creating, updating and viewing multiple resumes.
This project is solution to a Hackathon problem which made me secure Winner's Position in Hackathon.
Even though it was a Hackathon project, I still do enhancements and code optimizations to keep the project and my skills update.
- Good UI/UX
- Attractive GUI
- Easy to navigate
- Fetches the list of resumes from backend and shows on home screen.
- Can view individual resume details in whole
- Can create new resumes
- Can update existing resumes
- Can delete existing resumes
Click on image to see overview video tutorial.
-
First Fork the project to include it in your repositories.
- See how to fork here
-
Clone the repo in local machine.
- Open CLI or terminal and go to the directory you want to clone the project in and then type following command. (Replace
<YOUR_GITHUB_USERNAME>with your own github username)
git clone https://github.com/<YOUR_GITHUB_USERNAME>/resume-craft.git
- See how to clone here
- Open CLI or terminal and go to the directory you want to clone the project in and then type following command. (Replace
-
Main project directory has two sub-directories for
BackendandFrontend.
Let's first run backend so that frontend can connect with it.
-
Open project in any code editor of your choice, open terminal and then go to the
Backenddirectory from current mainresume-craftdirectory using the following command:cd Backend -
Install all dependencies by running following command:
npm install
-
Create a
.envfile and set environment variableDATABASE_CONNECTION_STRINGto your mongoDB atlas database.- If not sure how to connect to MongoDB atlas, take a reference here from step 4-8, which will work for this setup.
-
Finally to start backend locally, run following command:
npm start
-
You have successfully cloned and started the backend in
localhostenvironment on port -3030.
-
To start frontend, come back to main project directory
resume-craftfromBackenddirectory and go toFrontenddirectory using following commands:cd .. cd Frontend
-
Install all dependencies by running following command:
npm install
-
Finally to start frontend locally, run following command:
npm start
-
You have successfully cloned and started the frontend in
localhostenvironment on port -3000.
There is no extra step needed to connect frontend and backend, these two are already connected locally, if both are running on specified ports.
If you wish to make any changes or code optimizations that can enhance application UI or performance, create an issue here.
If got assigned, do desired changes and make a PR mentioning the issue solved.