A web application for creating resumes that can easily be modified to tailor it to a specific job application. This will easy the burden of maintaining multiple versions of your resume by providing a single source of truth, where you can edit the information that is shared by multiple resumes in one place, without information duplication.
When this web application is complete, you will easily be able to:
- Use different templates for your resume.
- show or hide some information in some resume by a single click of a button without deleting it.
- Rearrange your information using drag and drop.
- Convert your resume to PDF and DOCX.
- You will be able to use this service for free.
Clone the source code to your machine:
$ git clone https://github.com/kaddy120/chalk && cd chalkThe source code for app is arranged in the following monolithic structure.
.
├── server/
├── front-end/
├── compose-prod.yaml
├── compose.yaml
└── README.md
Where the server/ directory has the code for the RESTful API that is
written in javaScript using nodejs and express.js framework. And the
front-end/ uses react.js.
For development, you can either use Docker or develop in your machine.
The web app uses Github and Google OAuth2 for authentication. Before you can use Github and Google OAuth, you must register your application by creating a new project in the Google Developer Console and follow Creating an OAuth app guide for Github.
When registering the app, use:
http://localhost:3000/api/v1/auth/google/callbackas Authorization callback URL for Google.http://localhost:3000/api/v1/auth/github/callbackas Authorization callback URL for Github.
When you complete your application registration, you will get Client ID and
Client Secrets for both Google and Github. Write them in your .env file.
Create .env file in your ./server by running:
First, change to server directory.
$ cd server/In Linux/Unix system, create .env file using:
$ touch .env
In Windows system, create .env file using:
type nul > .env
The content of server/.env
NODE_ENV=development
GITHUB_CLIENT_ID=
GITHUB_CLIENT_SECRET=
GOOGLE_CLIENT_ID=
GOOGLE_CLIENT_SECRET=
The app uses mongoDB database to store use data. There are several ways in which
you can use mongoDB for this application. You can either install it in your
machine or use it with Docker, or use mongodb Atlas.
If you intent to use mongoDB with docker, we have already configured it. You can simply run the container using:
$ docker compose up -d mongo
To install the application dependencies and start the server, run:
$ npm install \
npm run devTest if you have configured the app's OAuth correctly by opening the URLs below in a browser to login in your using Google and Github OAuth.
http://localhost:3000/api/v1/login/googlehttp://localhost:3000/api/v1/login/github
When you successfully login, you will get redirect to your frontend at http://localhost:5000
Go to the front-end directory:
$ cd front-end
To install the application dependencies and start the front-end, run:
$ npm install \
npm run dev
The front-end is listening at http://localhost:5000.
Running the code in Docker is quite straight forward, but you must have Docker installed in your machine.
Run the following command in the project root directory:
$ docker compose up -d The above command starts three containers which are running mongoDB, frontend, and backend server, respectively.
Verify that the mentioned containers are running by using:
$ docker ps
In case you don't want to run all these services using docker, you can run selected images. For instance, only mongo and frontend, using:
$ docker compose up -d mongo frontendIf you want to rebuild the image, use --build flag.
To see the output log from the container, run
docker logs -f <container ID>
This web application will require some time to be production-ready. In the meantime, you can explore other resume creation applications; however, note that most of them come with a price tag.