Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/duffn/theouterrim

Fan-made stat site for Fantasy Flight Games' Star Wars role-playing game.
https://github.com/duffn/theouterrim

hacktoberfest star-wars

Last synced: about 1 month ago
JSON representation

Fan-made stat site for Fantasy Flight Games' Star Wars role-playing game.

Awesome Lists containing this project

README

        

# 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 Ruby >= 3.3 installed
- Install Ruby project dependencies

```
bundle install
```

- Install Node project dependencies

```
npm install
```

- Install `foreman`

```
gem install foreman
```

- Run the application

```
./bin/dev
```

- It will be available at http://localhost:4000.
- Open a PR with any changes you may have and a preview environment on Vercel will automatically be built.

### Contributing with stats

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.

## License

[MIT](https://opensource.org/licenses/MIT)