zion53/cv_builder

CV Builder

This is divided into two parts the frontend and backend.The compulsory Resume Builder API is in Backend folder created using Node.js while the optional Resume Builder UI is in frontend folder created using React.js

Installation

Clone the Repository

1. Open your terminal and navigate to the directory where you want to clone the repository.

2. Run the following command to clone the repository:

   git clone <Repo URL>
   

Backend Installation

1. Open the terminal in the downloaded folder and run command:

   cd backend
   

2. When in backend folder run command:

   npm install
   

Frontend Installation

1. Open the terminal in the downloaded folder and run command:

   cd frontend
   

2. When in backend folder run command:

   npm install
   

Usage

Backend Usage

1. Open the terminal in the downloaded folder and run command:

   cd backend

2. When in backend folder either run command:

   nodemon app.js

3. You can also use:

   npm start

4. Once the Server is active, feel free to use Postman or any other service for testing using "http://localhost:5000/api/resume"

   note: Api documenteation is specifiend inside backend folder.

Note: It uses local port 5000

Frontend Usage

1. Open the terminal in the downloaded folder and run command:

   cd frontend
   

2. When in frontenf folder run command:

   npm install

3. After all dependencies are installed, run:

   npm start

Note: It uses local port 3000

Incase any issue arises feel free to contact me.