Repository archived - development will continue here: https://github.com/slothpixel/web

ui

Slothpixel UI: A web interface for viewing Hypixel data. This utilizes the Slothpixel API, which is also an open source project.

Quickstart

• Install Node.js (6.0.0 or greater) (on Ubuntu, curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash - && sudo apt-get install -y nodejs)
• npm install
• npm start
• Visit port 3000 on your development machine.
• Make some changes
• npm run lint to check your code for linting errors
• Submit a pull request. Wait for review and merge.
• Congratulations! You're a contributor.

Configuration

• You can set the following environment variables:
  • PORT: Changes the port that the development server runs on
  • REACT_APP_API_HOST: Changes the API that the UI requests data from (default https://api.slothpixel.me)

Tech Stack

• View: React
• State Management: Redux
• CSS: styled-components

Notes

• You don't have to set up the entire stack (databases, etc.), or worry about getting starter data, since the UI points to the production API.
• Use the configuration to point to your own API (if you are working on a new feature and want to start building the UI before it's deployed to production).
• Discord: https://discord.gg/ND9bJKK)
  • Strongly recommended for active developers! We move fast and it's helpful to be up to speed with everything that's happening.

Resources

• New to React/Redux? Read these articles on React and watch video tutorials by Redux creator Dan Abramov.
  • Thinking in React: https://facebook.github.io/react/docs/thinking-in-react.html
  • Getting started with Redux: https://egghead.io/courses/getting-started-with-redux
  • Idiomatic Redux: https://egghead.io/courses/building-react-applications-with-idiomatic-redux
  • ES6 guide: https://github.com/lukehoban/es6features