Skip to content

Commit 99c1c02

Browse files
committed
Merge remote-tracking branch 'origin/main'
2 parents 50e5d19 + c843089 commit 99c1c02

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ API developed to search for a name by it's metaphone (br) on database and return
44

55
## Setup
66
- create a MySql database, you can use [this script](https://github.com/Darklabel91/API_Names/blob/main/database/create_database.txt) if needed
7+
- set a .env file on the project with ```DB_USERNAME```, ```DB_PASSWORD```, ```DB_NAME```, ```DB_HOST``` and ```DB_PORT```
78
- run the API ```go run main.go```
89
- use import wizzard on mysql workbench to upload the [.csv file](https://github.com/Darklabel91/API_Names/blob/main/database/name_types.csv)
910
- have fun
@@ -105,3 +106,5 @@ Every method expect Status:200 and JSON content-type as show bellow:
105106
]
106107
}
107108
```
109+
## Dependacy
110+
[metaphone-br](https://github.com/Darklabel91/metaphone-br)

0 commit comments

Comments
 (0)