https://github.com/wfcd/warframe-hub
:blue_book: Warframe hub strives to be the community center of the Warframe game
https://github.com/wfcd/warframe-hub
warframe-community warframe-hub
Last synced: about 2 months ago
JSON representation
:blue_book: Warframe hub strives to be the community center of the Warframe game
- Host: GitHub
- URL: https://github.com/wfcd/warframe-hub
- Owner: WFCD
- License: apache-2.0
- Created: 2017-10-18T15:36:09.000Z (over 7 years ago)
- Default Branch: dev
- Last Pushed: 2025-04-05T03:16:06.000Z (about 2 months ago)
- Last Synced: 2025-04-05T04:19:55.374Z (about 2 months ago)
- Topics: warframe-community, warframe-hub
- Language: JavaScript
- Homepage: https://hub.warframestat.us
- Size: 68 MB
- Stars: 91
- Watchers: 6
- Forks: 29
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# Warframe Hub
[](https://vercel.com/wfcd/warframe-hub)
[](https://github.com/WFCD/warframe-hub/actions/workflows/ci.yaml)
[](https://github.com/WFCD/warframe-hub/actions/workflows/release.yml)
[](https://github.com/WFCD/banner/blob/master/PROJECTS.md)
[](https://discord.gg/jGZxH9f)
## Prerequisite
In order to run your own version of Warframe Hub, you are required to have the following on your machine:
- [Node > 10.13.0](https://nodejs.org/en/) for running the project
- [NPM > 6.4.1](https://www.npmjs.com/get-npm) for dependency control, usually installed with Node.js
## Dependencies
Most software related dependencies should be managed by NPM, and will be automatically installed when you try to run the project. We'll cover those dependencies in the following section.
Warframe Hub also relies on the availability of the internet, as it will parse the Warframe WorldState. It uses a slightly easier to parse WorldState provided by [Warframe Stat.us](https://docs.warframestat.us/), [API](https://api.warframestat.us).
## Installation
Clone or download and unpack this repository. Install the dependencies using NPM
```bash
$ npm i
```
If everything goes well, it should tell you the number of packages it has installed. Then you can try to run it and hope everything goes well.
```bash
$ npm run build
$ npm start
```
The website will be available for viewing at http://localhost:3000
## Development
This website runs on Vue.js, and it does come with a development server that refreshes when it detects code changes. Nodemon is no longer needed as vue comes with its own hot reloader. You can launch the development server using:
```bash
$ npm run dev
```
We've switched to [nuxt.js](https://github.com/nuxt/nuxt.js) for our framework instead of freeform Vue
## Bug/Issue Report
Found a bug or an issue? Please submit a bug/issue report under the [issue tab](htps://github.com/wfcd/warframe-hub/issues).
## Testing
Our builds leverage GitHub actions to test via cypress & linting.
You can see the latest results [here](https://github.com/WFCD/warframe-hub/actions/workflows/ci.yaml) or by clicking on the badge at the top of the page.
### Local Tooling
#### Linting
Only updated files are generally linted, and you can lint them with
```bash
npm run lint
```
or to fix many issues automatically,
```bash
npm run lint:fix
```
#### Cypress
We leverage [Cypress](https://github.com/cypress-io) for testing our frontend code. Tests should be run locally, but if you're developing without tooling locally, the tests will run on github actions when you push to a pull request.
Local testing command, must be run with an instance (either `npm start` or `npm run dev`) currently running
```bash
npm test
```
## License
The distribution of this software is protected under [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0). If the legal language in the original document is too scary for you, you can view a plain-English version of Apache License which outlines what you can and cannot do with this project [HERE]()
## Small Note
Like most projects, Warframe Hub is purely out of passion, love, and dedication to the Warframe Community and open source software in general. This is not our fulltime job, and probably will never be. No donations will be encouraged because once a person starts to receive payments for a passion project, is it still a passion?