xBromsson/dnd-spells

JavaScript

🎲 DnD 5e Spell List

📖 About

This is a searchable list of DnD 5e spells fetched from Open5e API. 👉 Open5e github

📸 Screen Shots

🌟 Current Features:

Lists all spells available in the DnD SRD. Learn more about the SRD 📑 Here
Spells are listed in a beautiful column & row format
All fields are filterable via a search bar

📋 Planned Features:

Ability to click on a spell to open single page details about that spell
Ability to sort columns alphabetically or numerically (ascending and descending)

🛠️ Built With

📝 Languages

HTML: Used for structuring the content on the web page.
JavaScript: Adds interactivity and handles data manipulation.
CSS: Styles the web page for a better user experience.

📚 Libraries and Frameworks

None used for this project.

🌐 APIs and Services

Fetch API: Utilized for making network requests to retrieve data from external sources.
DOM API: Employed for client-side manipulation of the document structure, style, and content.
Open5e API: Consumed for fetching Dungeons & Dragons data.

📦 Package Managers

NPM: Handles dependency management and scripts.

🛠️ Development Tools

Live Server: Used for setting up a local development server for real-time website updates.

💻 Installation / Setup

clone this repo to your machine:

git clone https://github.com/xBromsson/dnd-spells.git

install all the dependencies

npm install

now to preview the web app just run

npm start

📜 License

This project is released into the public domain using The Unlicense - see the LICENSE file for details.

🤝 Contributing

We welcome contributions to this project! Here's how you can help:

Fork the Repository: Create a fork of this project to your GitHub account.

Clone the Fork: Clone the fork to your local machine.

git clone https://github.com/your-username/project-name.git

Create a Branch: Create a new branch to work on.
```
git checkout -b my-new-feature
```
Make Changes: Make your changes or additions to the new branch.
Commit and Push: Commit your changes to your own branch and push the work back up to your fork.
```
git push origin my-new-feature
```
Pull Request: Open a pull request to propose your changes to the main branch.

For more information on using GitHub, please refer to GitHub's How To.

Thank you for your contributions!