✨ Pokemon API ✨

A Go API that returns pokemon information like name, type, stats, etc.

📑 Table of Contents

• Installation
• Justification
• Contribute
• Things to do - Contribute ideas

⚙ Installation

1. Clone the repo and go to the directory.

$ git clone https://github.com/AriDevK/PokeGO_API.git
or
$ git clone [email protected]:AriDevK/PokeGO_API.git
$ cd PokeGO_API/src

2. Install the dependencies and use the recommended node version:

$ go get .

3. Start the server and serve the application

$ go run .

4. Open your browser and go to http://localhost:8080/swagger/index.html to see the documentation (this may change if you change the port in the config file)

🗳 Justification

Just for learn and practice my skills with Go and SQL Server.

On this project I used:

• Go : The programming language
• Echo : The minimalist web framework
• gorm : The ORM for Go (a funny name xDx)
• viper : The config manager
• Microsoft SQL Server : The database
• Swagger : The documentation
• YAML : The config file format

🗳 Contribute

You can contribute to the development or improvement of this app and it will be much appreciated if you do 🥰

Step 1

• Fork this repo

Step 2

• Magic Magic Magic ✨✨✨

Step 3

• Create a new pull request

💭 Things to do - Contribute ideas

These are things that I will implement later (You can also take these ideas if you want to contribute 😊)

• Add endpoints to get pokemon by name
• Add query parameter to get mega evolutions
• Add query parameter to get pokemon by stat
• Add query parameter to get pokemon by ability (this includes adding the ability table)
• Add query parameter to get pokemon by egg group (this includes adding the egg group table)
• Add query parameter to get pokemon by color (this includes adding the color table)