An open API service indexing awesome lists of open source software.

https://github.com/kauefraga/warframe-interface

🎮 Faster and easy to understand Warframe information | https://docs.warframestat.us
https://github.com/kauefraga/warframe-interface

cli interface monorepo nodejs portable typescript warframe website

Last synced: about 2 months ago
JSON representation

🎮 Faster and easy to understand Warframe information | https://docs.warframestat.us

Awesome Lists containing this project

README

          


Warframe Interface


🎮 Faster and easy to understand Warframe information 🎮


GitHub top language
Repository size

GitHub last commit

GitHub LICENSE


> I was searching for something to do and discovered the Warframe Worldstate API,
therefore i decided to give it a try. Chose Node because i know the ecosystem
better (npm) than Python's one. Also, i want to create some static site with [Astro](https://astro.build) and it's the opportunity to.

### Features

- All source code stored in a single project (monorepo).
- Typescript developer experience is something.

## 📦 Packages (pnpm workspace)

- 🚧 [Command Line Interface](packages/cli)
- 🚧 [Site](packages/web)

## 🎲 Prerequisites

To run this project you will need to have [Node](https://nodejs.org/en).
- Node Version Managers: [fnm](https://github.com/Schniz/fnm), [nvm](https://github.com/nvm-sh/nvm), [asdf](https://asdf-vm.com)...

## ⬇️ How to install and use it

1. Clone the repository and enter in it
2. Install all the dependencies
3. Select some of the packages above and read the documentation

```bash
git clone https://github.com/kauefraga/warframe-interface.git
cd warframe-interface

pnpm i --frozen-lockfile
```
You are welcome to open issues and pull requests!

## 🛠 Technologies

The following tools have been used to build the whole project:

- [Warframe Worldstate](https://docs.warframestat.us) - An API that provides "everything about Warframe".
- [Node](https://nodejs.org/en) - A runtime based on V8 JavaScript.
- [Eslint](https://npm.im/eslint-config-airbnb-typescript) - Code ruler/styler with Airbnb style guide.
- [Typescript](https://typescriptlang.org), [tsx](https://www.npmjs.com/package/tsx) and [tsup](https://www.npmjs.com/package/tsup) - Improve the DX by adding type safety and a blazingly fast execution/build provided by esbuild.

## 📝 License

This project is licensed under the GPL-3.0 License - See the [LICENSE](https://github.com/kauefraga/warframe-interface/blob/main/LICENSE) for more information.

---


Built with love
Powered by coffee