Git Product home page Git Product logo

theouterrim's Introduction

The Outer Rim

The Outer Rim is a fan-made site for Fantasy Flight Games' Star Wars role-playing game. Find it at https://theouterrim.co.

Contributing

You can contribute with either code but also with audits and creation of new stats. Any and all help is equally appreciated!

Contributing with code

Running the project

  • Have Node.js >=14
  • Install project dependencies
yarn install
  • Run the application
yarn start

Building the project

You can also build the project, run it locally, and approximate what a production build will look like.

  • Have Node.js >=14
  • Install project dependencies
yarn install
  • Build the application
yarn build
  • Run the application
yarn serve

Contributing with stats

YAML

All of the stats are kept in the data directory in one file each per stat type. In order to add a new entry, follow the format in the YAML file.

Audits of current stats are welcome and appreciated. Even a single character counts!

If you have any questions about stats, don't hesitate to open an issue.

Spreadsheet

You can also currently add new stats in a central spreadsheet. See the instructions there.

Just contact me

Finally, so you can also find me on the SWRPG Discord or Mastodon under the same username.

If you want to contribute in any way, please don't hesitate to just reach out and let's chat!

License

MIT

theouterrim's People

Contributors

abhiaiyer91 avatar alexholliz avatar andrelemay avatar dependabot[bot] avatar duffn avatar hussamkhatib avatar tailball avatar xunrel avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

theouterrim's Issues

Sorting by price is broken when using a comma separator

Sorting Gear by price, they are displayed with a comma. But this appears to break sorting order, where “100” sorts after “10,500”. Standard numeric sorting is also broken, where 25 sorts after 200.

I think you’re going to have to convert them from strings to integers, then convert them back on display.

Note that if the site is going to be localized into other languages, they might not use a comma as their thousands separator, so you might not want to bake that in.

This might also require breaking out the “(R)” for Restricted into a separate column.

Add new required columns

Our first community member has finished entering content for a book! Rise of the Separatists! Thank you P-47 Thunderbolt from the FFG formums!

Here's the spreadsheet: https://docs.google.com/spreadsheets/d/1FgGOmFdgbqTx8l4HVCT0huPdtztDUfzaZB04ur-SB6M/edit#gid=2094253977

After some discussion, we decided to include some additional columns. That means we need to add these additional columns to the already existing data.

  • Review the spreadsheet and the already existing data
  • Add the new columns where necessary

Add a changelog page to the site

I plan on tracking releases in GitHub, but that can be not the most user friendly for non-developers.

We should have a page on the site that just hits the highlights of releases, but link to the GitHub release for more detail. I'm currently doing a blog for SWSheets for this purpose. We could consider that in the future.

Damage for melee weapons missing the "+" sign

I took a look at the data, and it seems that all weapons that should have a + sign at the front of their damage are missing it, making it difficult to determine which weapons benefits from brawn and which doesn't.

Audit categories of older books for finer grain categorization

Right now all of the categories for attachments for example are very broad like Weapon, while they could be finer grained like Melee and Brawl Weapon Attachments, Grenade and Micro-Rocket Attachments, and Ranged Weapon Attachments.

We should go back and audit the older books to change the categories from the very broad definition to the tighter definition.

Review and improve metadata on pages

We should look at what the SEO component is rendering for pages. I raced over that before launching, but it can probably be bettered.

Good meta would be helpful when sharing resource URLs, like in Discord.

Add dark mode theme for the site

Short URLs

It would be cool to have short URLs for resources.

I’ve never tried this, but seems like it would be possible with Netlify redirects and the Gatsby Netlify plugin.

Domain redirect from the short domain and then from the short path to the full resource path. Each resource would need another element in the YAML with the short path, then use createRedirect from there.

Just a fun thing, time permitting and assuming I want to buy another domain like ther.im.

Correct the width of the tables

The width of all the tables is a bit of a mess. They're all over the place. It would be nice to:

  • Have all the tables all the same width. (Maybe? Or does this make the tables with fewer columns look odd?)
  • Make the tables scale appropriately on smaller screen sizes.

I can split these into two issues if smaller screen sizes is different work and a bigger lift than just make the table width better.

Review and possibly update Int columns with new incoming content

New content created by contributors may have values in fields like encumbrance, rarity, damage, etc. that are not Ints. It may be that these do actually need to be strings.

Review and change columns to string types if necessary.

Related to #45.

Examples

From a contributor

I believe the book uses "-" to differentiate from Incidental items ( which would be "0"). I can switch it to 0, but wanted to run that by you first.

Remove unneeded data columns

These columns are all 0 in every case. There's no reason to list them, so to simplify, let's remove them.

  • Adversary gear encumbrance
  • Adversary armor encumbrance
  • Adversary armor hp

Add ability to show all items in a table

As requested here, it would be nice to allow users to show all of the items in a table instead of just the preconfigured number of records. https://www.reddit.com/r/swrpg/comments/f6nyyh/introducing_the_outer_rim_swrpg_stats_site_and/fi6vw7h?utm_source=share&utm_medium=web2x

It's not immediately clear how to do this from the material table docs, so we could just hack a 1000 or something large in the pageSizeOptions for a short-term band-aid:

pageSizeOptions: [25, 50, 100],

Create a logo for the site

I made the favicon with some online generator, but it would be very cool to have a logo for the site. I’m not sure exactly what I’d be looking for but am open to suggestions. For reference I do like the SWSheets logo. It’s clean, simple and Star Wars-esque.

I’ll certainly need help in this department!

Create a "minimal" version of the pages

One user expressed concerned that the site was a little to heavy for its very utilitarian purpose. I think that's a fair criticism.

I think in addition to the pretty site, we could potentially support some sort of minimal version of the pages that just shows all of the data, minimal styling, no pagination, no fancy filtering, sorting, etc. etc.

https://www.reddit.com/r/swrpg/comments/f6nyyh/introducing_the_outer_rim_swrpg_stats_site_and/fi7gm2q?utm_source=share&utm_medium=web2x

Create permalinks for table views

Maybe I’m missing something, but it would be useful if there was an easy way we could give people to link to any table view they might create.

For example, if I go to the page at https://theouterrim.co/weapon-attachments/ and search for “crystal”, I should be able to get back a link that I can then easily share with others, so that they can see all lightsaber crystals that we know of.

If I then drag “HP” to the “Group By” column, I should be able to get a link for that which will take me to a list of all known crystals, grouped by their HP cost.

Is this already a feature that is present and I just don’t know about it?

Add some tests

There are currently no tests. 😬

We should add some.

Eventually I'd like to get CircleCI and Codecov involved, but let's get some simple tests running first.

Add sufficient test coverage

Okay, we have CircleCI and a single test up. We should add sufficient test coverage to the app, testing the critical components and pages.

Add page for users helping with adding content

The community is helping! #1. I can confirm one book is already being worked on. We should add some sort of page recognizing the users that help with adding content - separate from monetary supporters.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.