diff --git a/README.md b/README.md
index ef9db6d..b3b893c 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,60 @@
-# CV Management System API
+### **CV Management System API ๐ โ๏ธ**
+
+
+**This project provides a platform for managing user data and generating custom CV templates.**
+
+
+
+
+
+
+
+
+
+
+
+
+[](https://reddit.com/submit?url=https://github.com/)
+[](https://github.com/damarisnicolae/CV_project/graphs/contributors/)
+
+
+
+
+
+
+### **Table of contents**
+
+
+1. [Directory structure Hierarchy](#directory-structure-hierarchy)
+2. [Components](#components)
+3. [Prerequisites](#prerequisites)
+4. [Environment variables file .env file](#environment-variables-file-env-file)
+5. [Install Basic Tools](#install-basic-tools)
+6. [Replace Paths](#replace-paths)
+7. [Create DB, users table](#create-db-users-table)
+8. [Verify successful import](#verify-successful-import)
+9. [Change DB user password](#change-db-user-password)
+10. [Build the backend API](#build-the-backend-api)
+11. [BFF Flask app setup frontend](#bff-flask-app-setup-frontend)
+12. [SSH conection](#ssh-conection)
+13. [Github commit](#github-commit)
+14. [Start the project](#start-the-project-makefile)
+15. [Docker](#docker)
+16. [Browser links](#browser-links)
+17. [Other free resources](#other-free-resources)
+
+
+### **Directory structure Hierarchy**
+
-This project provides a platform for managing user data and generating custom CV templates.
-## Directory structure Hierarchy
```sh
CV_project
+โโโ .github # GitHub configuration directory
+โ โโโ workflows # GitHub Actions workflows
+โ โโโ integration-tests.yml # Workflow for integration tests
+โ โโโ unit-tests.yml # Workflow for unit tests
+โ โโโ venom-tests.yml # Workflow for venom tests
โโโ api # Go API - backend
โ โโโ CV_project # Executable file ... (cd $PathCvProject/api && go build -o CV_project main.go)
โ โโโ example.pdf # Sample PDF
@@ -29,36 +79,33 @@ CV_project
โ โ โโโ template2.html # CV template 2
โ โ โโโ template3.html # CV template 3
โ โโโ users.js # JavaScript - user-related functionality
-โโโ db.cnf # Database configuration
-โโโ docker-compose.yml # Docker Compose configuration
-โโโ .env # Environment variables file
-โโโ .gitignore # Git ignore - version control
-โโโ .github # GitHub configuration directory
-โ โโโ workflows # GitHub Actions workflows
-โ โโโ integration-tests.yml # Workflow for integration tests
-โ โโโ unit-tests.yml # Workflow for unit tests
-โ โโโ venom-tests.yml # Workflow for venom tests
-โโโ Makefile # Building and running
-โโโ README.md # Project documentation
โโโ sql # SQL files - database schema
-โ โโโ db.cnf # Database configuration
โ โโโ Dockerfile # Dockerfile - sql
-โ โโโ mysql.pid # MySQL process ID file
โ โโโ schemadump.sql # Schema creation and sample data
โ โโโ schema.sql # Schema creation only
-โโโ src # Source code
- โโโ __init__.py # Initialization and configuration
+โโโ src # Source code
+โ โโโ __init__.py # Initialization and configuration
+โโโ .env # Environment variables file
+โโโ .gitignore # Git ignore - version control
+โโโ Makefile # Building and running
+โโโ README.md # Project documentation
+โโโ docker-compose.yml # Docker Compose configuration
```
+
-## Components:
+### **Components:**
+
- Backend (Go) : HandlMYSQL_
+ Backend (Go) : Handles user data management, authentication, and PDF generation.
+ Frontend (Python,Flask) : Provides the web interface for user interaction.
+ Database (SQL) : Stores user information.
-MYSQL_s user data management, authentication, and PDF generation.
-Frontend (Python,Flask) : Provides the web interface for user interaction.
-Database (SQL) : Stores user information.
+
-## Prerequisites:
+### **Prerequisites:**
+
- `Go `: _Backend development_
- `Flask `: _Frontend development_
@@ -68,7 +115,12 @@ Database (SQL) : Stores user information.
- `Docker & Docker Compose `: _Containerized deployment_
-## Environment variables file: .env file
+
+
+### **Environment variables file: .env file**
+
```sh
MYSQL_ROOT_PASSWORD=***
@@ -81,7 +133,12 @@ MYSQL_DATABASE=users
MYSQL_PORT=3306
```
-## Install Basic Tools:
+
+
+### **Install Basic Tools:**
+
```sh
sudo apt update && sudo apt upgrade && sudo apt install -y git curl build-essential golang-go python3 python3-pip wkhtmltopdf docker.io docker-compose selinux-utils curl mysql-server
@@ -89,14 +146,24 @@ sudo mysql_secure_installation
pip install --break-system-packages Flask Flask-Bcrypt Flask-Migrate Flask-SQLAlchemy
```
-## Replace Paths
+
+
+### **Replace Paths**
+
```sh
PathCvProject="/bcn/github/CV_project"
grep -q "PathCvProject=" ~/.bashrc || echo "export PathCvProject=\"$PathCvProject\" # Set path to CV project." >> ~/.bashrc && source ~/.bashrc
```
-## Create DB, users table
+
+
+### **Create DB, users table**
+
```sh
sudo mysql -u root -p
@@ -105,7 +172,12 @@ USE users;
SOURCE /bcn/github/CV_project/sql/schemadump.sql;
```
-## Verify successful import
+
+
+### **Verify successful import**
+
```sh
mysql -u root -p users
@@ -118,13 +190,23 @@ SELECT * FROM template;
SELECT * FROM users;
```
-## Change DB user password
+
+
+### **Change DB user password**
+
```sh
ALTER USER 'CV_user'@'localhost' IDENTIFIED BY 'Y0ur_strong_password';
```
-## Build the backend API
+
+
+### **Build the backend API**
+
```sh
cd $PathCvProject/api
@@ -135,16 +217,25 @@ export DB_PASSWORD="?????????????"
./CV_project
```
+
+
## BFF Flask app setup frontend
+
```sh
cd $PathCvProject/bff
python3 app.py -i 127.0.0.1 -p 8080
```
-# Github
+
+
-### SSH conection
+### **Github SSH conection**
+
```sh
GitSshKey="/PathTo/.ssh/github_rsa"
@@ -158,7 +249,12 @@ git config --global http.sslBackend "openssl"
ssh -T git@github.com
```
-### Commit & pull-push, avoid conflicts
+
+
+### **Github commits**
+
```sh
echo "Enter commit message (Title case, infinitive verb, brief and clear summary of changes):"
@@ -169,7 +265,12 @@ git commit -m "$CommitMssg"
git pull && git push origin main
```
-## Start the project: Makefile
+
+
+### **Start the project: Makefile**
+
```sh
cd $PathCvProject
@@ -178,25 +279,100 @@ make # Build and start the services
make docker # # Start services using Docker Compose
```
-## Docker
+
-```sh
-docker-compose build # build
-docker-compose up # start
-docker-compose up -d # run background
-docker-compose stop # only stop
-docker-compose down # stops and removes containers
-docker-compose ps # view running containers
-docker-compose rm # removes stopped service containers
-```
-## Browser links
+### ****Docker****
+
+
+| | Command | Description |
+|:---|:---|:---|
+|๐จ |`docker-compose build ` |# build
+|๐ผ |`docker-compose up ` |# start
+|๐ |`docker-compose up -d ` |# run background
+|๐ |`docker-compose stop ` |# only stop
+|๐ฝ |`docker-compose down ` |# stops and removes containers
+|๐ฉบ |`docker-compose ps ` |# view running containers
+|๐งน |`docker-compose rm ` |# removes stopped service containers
+
+
+
+
+### **Browser links**
+
+
+- [Miro](https://miro.com/app/board/uXjVK6HA_1A=/)
+
+- [template1](http://127.0.0.1:5000/template1)
+
+- [template2](http://127.0.0.1:5000/template2)
+
+- [template3](http://127.0.0.1:5000/template3)
+#
+
+
+### **List of Free Learning Resources In Many Languages**
+
+
+
+
+[](https://github.com/sindresorhus/awesome)
+[](https://creativecommons.org/licenses/by/4.0/)
+[](https://github.com/EbookFoundation/free-programming-books/pulls?q=is%3Apr+is%3Amerged+created%3A2023-10-01..2023-10-31)
+
+
+
+
+### **Where To Look For Further Info :thinking:**
+
+
+- [freeCodeCamp Guide](https://guide.freecodecamp.org/)
+- [GeeksForGeeks](https://www.geeksforgeeks.org/)
+- [Dev.To](https://dev.to/)
+- [Stack Overflow](https://stackoverflow.com/)
+- [Dzone](https://dzone.com/)
+
+
+### **Other free resources**
+
-https://miro.com/app/board/uXjVK6HA_1A=/
++ [English, Books By Programming Language](https://github.com/EbookFoundation/free-programming-books/blob/main/books/free-programming-books-langs.md/)
++ [English, Interactive Programming Resources](https://github.com/EbookFoundation/free-programming-books/blob/main/more/free-programming-interactive-tutorials-en.md)
++ [English Courses](https://github.com/EbookFoundation/free-programming-books/blob/main/courses/free-courses-en.md)
-http://127.0.0.1:5000/template1
+
-http://127.0.0.1:5000/template2
+### **Coding Practice Sites :zap:**
+
-http://127.0.0.1:5000/template3
+- :link: [CodeForces](http://codeforces.com/)
+- :link: [CodeChef](https://www.codechef.com)
+- :link: [Coderbyte](https://coderbyte.com/)
+- :link: [CodinGame](https://www.codingame.com/)
+- :link: [Cs Academy](https://csacademy.com/)
+- :link: [HackerRank](https://hackerrank.com/)
+- :link: [Spoj](https://spoj.com/)
+- :link: [HackerEarth](https://hackerearth.com/)
+- :link: [TopCoder](https://www.topcoder.com/)
+- :link: [Codewars](https://codewars.com/)
+- :link: [Exercism](http://www.exercism.io/)
+- :link: [CodeSignal](https://codesignal.com/)
+- :link: [Project Euler](https://projecteuler.net/)
+- :link: [LeetCode](https://leetcode.com/)
+- :link: [Firecode.io](https://www.firecode.io/)
+- :link: [InterviewBit](https://www.interviewbit.com/)
+- :link: [uCoder](https://ucoder.com.br)
+- :link: [LintCode](https://www.lintcode.com/)
+- :link: [CodeCombat](https://codecombat.com/)
+- :link: [InterviewCake](https://www.interviewcake.com/)
+- :link: [At Coder](https://atcoder.jp/)
+- :link: [Codility](https://www.codility.com/)
+- :link: [ICPC Problem Archive](https://icpc.kattis.com/)
+- :link: [Codemia](https://codemia.io/)