to-sta / cv_constructor Goto Github PK

CV Constructor is a software that simplifies the process of creating a CV (Curriculum Vitae). With CV Constructor, users can input their information and choose from a variety of templates and colors to create their CV. The software is designed to be user-friendly and intuitive, making it easy for anyone to create a professional-looking CV in no time.

Here is an early stage example of the editor.

Contributions to CV Constructor are always welcome. Check the open issues or if you suggestions create an issue.

1. Install git:

   For instructions see https://git-scm.com/.

2. To setup your development environment, first install Docker and Docker-Compose.

3. Fork the project:

   Click the "fork" button on the top of this repository (repo) to create a copy of the project for you to work on. You will need a GitHub account. This will allow you to make a "Pull Request" (PR) to this repo later on.

4. Clone your fork to your local machine:

   git clone https://github.com/<your-username>/cv_constructor.git

   GitHub will provide both a SSH and HTTPS url for cloning. You can use SSH if you have SSH keys setup.

5. Change the directory to enter the project folder:

   cd cv_constructor

6. Add the upstream repository:

   git remote add https://github.com/to-sta/cv_constructor.git

   [!INFO] With the command git remote -v you can check if it was successful. You should see two remote repos named origin and upstream.

7. Install Pre-commit:

   pre-commit install

   This will ensure during development that each of your commits is properly formatted against our linter and formatters.

8. Create a .env file and start your docker images with the following:

   cp .env.example .env
   docker-compose up
   # Or with new dependencies:
   # docker-compose up --build

9. Then you are able to visit the frontend and backend on:

   • frontend: http://localhost:5174
   • backend: http://localhost:8000

1. Checkout your local repo's main branch and pull the latest changes from the upstream, into your local repo:

   git checkout main
   git pull

2. Create a seperate branch for your contribution:

   git branch <name-of-the-branch>
   git checkout <name-of-the-branch>

3. Write some code 😃

1. Update your fork on GitHub to reflect your local changes

   git push -u origin <branch name>

2. Make a pull request on GitHub 🚀

   Please describe your contribution briefly.

   • What have you implemented / changed?
   • Did you test your changes?

   We ran automated tests on every PR, these include linting, formatting and logic test for the backend and frontend.

   You will likely be asked to edit or modify your PR in one way or another during this process. This is not an indictment of your work, but rather a strong signal that the community wants to merge your changes!

   Once approved, your changes may be merged!

   🎉 🎉 🎉