Skip to content

Commit

Permalink
fix docs files and README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rafaeljurkfitz committed Apr 20, 2024
1 parent fdc7f06 commit 0f5d58e
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 24 deletions.
48 changes: 24 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,48 +26,48 @@ This repository is for studying and serving as a portfolio. The goal here is to

1. Clone the repository:

```bash
git clone https://github.com/rafaeljurkfitz/etl-excel.git
cd etl-excel
```
```bash
git clone https://github.com/rafaeljurkfitz/etl-excel.git
cd etl-excel
```

2. Configure the correct Python version with `pyenv`::

```bash
pyenv install 3.12.1
pyenv local 3.12.1
```
```bash
pyenv install 3.12.1
pyenv local 3.12.1
```

3. Configure poetry for Python version 3.12.1 and activate the virtual environment:

```bash
poetry env use 3.12.1
poetry shell
```
```bash
poetry env use 3.12.1
poetry shell
```

4. Install the project dependencies:

```bash
poetry install
```
```bash
poetry install
```

5. Run the tests to ensure everything is working as expected:

```bash
task test
```
```bash
task test
```

6. Run the command to view the project documentation:

```bash
task doc
```
```bash
task doc
```

7. Run the pipeline execution command to perform the ETL:

```bash
task run
```
```bash
task run
```

8. Check the ```data/output``` folder to see if the file was generated correctly.

Expand Down
1 change: 1 addition & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ The objective of this project is to demonstrate how refactoring techniques can b
## Installation Guide

Here, you will find detailed instructions on how to install and configure the project in your local environment. Following the instructions correctly ensures that you have a smooth experience when working on the project.

## FAQ

This section provides answers to frequently asked questions. If you have any questions that are not covered here, please feel free to get in touch.
Expand Down

0 comments on commit 0f5d58e

Please sign in to comment.