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

https://github.com/open5e/open5e

An SRD and open-source material reference site for 5th edition D&D
https://github.com/open5e/open5e

nuxt vue

Last synced: 3 months ago
JSON representation

An SRD and open-source material reference site for 5th edition D&D

Awesome Lists containing this project

README

          


Open5e logo

Open5e



https://open5e.com


Site for browsing open D&D 5e content




API


homepage


API
  •  
Discord
  •  
Patreon


# Introduction

Open5e is a community project driven by a small number of volunteers in their
spare time. We welcome any and all contributions!

Useful places to check out:

- [Our discord](https://discord.gg/9RNE2rY) where we discuss the project and
generally pal around. Bring your best memes.
- [The project org homepage](https://github.com/open5e) which has links to our
roadmaps and other resources

# Development

Open5e uses the Nuxt3 framework for Vue3, which takes care of a lot of the
architectural work for the frontend layer while allowing a large amount of
flexibility.

5e game content is fetched from the
[open5e API](https://github.com/open5e/open5e-api) running at
https://api.open5e.com. This can be redirected using the environment variable
`API_URL`.

## Build Setup

Install dependencies.

```bash
npm install
```

Run the page in development mode.

```bash
npm run dev
```

Build for production and launch server.

```bash
npm start
```

Generate static project for publishing.

```bash
npm run generate
```

For detailed explanation on how things work, checkout the
[Nuxt.js docs](https://github.com/nuxt/nuxt.js).