Security News
tea.xyz Spam Plagues npm and RubyGems Package Registries
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
pokedata
Advanced tools
Readme
👻 Static Pokémon API containing all core games data.
PokéData is a static Pokémon API, based on the Veekun Pokédex project, the same data source of PokéAPI.
The main difference, apart from the simplified API format (less calls are needed for getting more info), is that the PokéData API doesn't need a server to work and can be served offline, since it is based purely on static JSON files structured directories similar to RESTFul naming patterns. This is perfect for single-page static webapps capable of working offline or for any kind of project that doesn't want to rely on an external API server.
You can download the generated static API files or install the project following one of the next options.
If you want to contribute to this project, you will need these requirements in your computer:
Cloning the project and setting up the environment:
git clone https://github.com/capsulemonsters/pokedata.git
cd pokedata
src/Resources/scripts/install.sh
After the project is installed, the build scripts can be used to generate the API. The most important ones are:
src/Resources/scripts/build-api.sh
: Builds the API under the build/api
directory.src/Resources/scripts/build-api-docs.sh
: Builds the API docs under the build/docs
directory.src/Resources/scripts/build-src-yaml.sh
: Builds the YAML files under the src/Recources/data
directory.There are also other scripts under the src/Recources/scripts
directory, but they are mainly used by Travis CI
and other scripts, so most of the time there is no need to call them manually.
You can also run make
locally to generate the API, the API docs and the pokedata-api
docker image,
which provides a container with the generated API, served with nginx.
Optionally, you also have the option to consume the API with a ready-to use Docker container, which already contains the generated API and it is served with nginx.
The API will be found under the /api
base URL, while the docs under /docs
, just like in the official project
site.
To start a new API instance simply run docker run -d itsjavi/pokedata-api
.
You can check the list of available builds in Docker Hub.
The docker image versions always match the project semver tags.
The generated API is also available as NPM package
and can be installed using npm i pokedata
.
Apart from the current TO-DO's list, these are some of the goals of this project:
This software is copyrighted and licensed under the MIT license.
This software comes bundled with data and graphics extracted from the Pokémon series of video games. Some terminology from the Pokémon franchise is also necessarily used within the software itself. This is all the intellectual property of Nintendo, Creatures, inc., and GAME FREAK, inc. and is protected by various copyrights and trademarks.
The authors believe that the use of this intellectual property for a fan reference is covered by fair use and that the software is significantly impaired without said property included. Any use of this copyrighted property is at your own legal risk.
This software is not affiliated in any way with Nintendo, Pokémon or any other game company.
A complete revision history of this software is available from https://github.com/capsulemonsters/pokedata
FAQs
Static Pokémon API containing all core games data
The npm package pokedata receives a total of 0 weekly downloads. As such, pokedata popularity was classified as not popular.
We found that pokedata demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.