404pandas / campaign-notebook

Application that allows users to store information about their campaign with the assistance of D&D 5e API.

---

Dungeons & Dragons Campaign Notebook

Explore the docs »
View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

This project will initially be build with html, css, and javascript to show a build process to students in the UCF Full Stack Coding Bootcamp. Once back end is introduced to students, will add Postgres. Once MERN is introduced to the students, will convert and deploy as a PERN app.

Built With

Getting Started

Once completely built, this application will function as a deployed app on Render

Local Installation / Testing

If you would like you clone and test this app locally, please follow these instructions:

1. Clone the rep

git clone https://github.com/404pandas/campaign-notebook.git

2. Install dependencies

npm run install

3. Seed the database

npm run seed

4. Launch the app in development environments

npm run develop

5. Visit:

localhost

Usage

Once the app is functional, screenshots will be added in this section.

Roadmap

MVP

• Front End

  • General Layout

    • HTML Skeleton
    • Book
    • Tabs
      • Arrows
      • Discs
    • Pop Out Menu
    • Add button
    • Edit button
    • Vertical Page title
    • Font

  • Party

  • Inventory

  • NPCs

  • Locations

  • Main Story

  • Side Story

  • Rules

  • Drawings

Future Development

• Back End
  • Users
  • Campaigns viewable by others

Wireframes

Click here for the visme wireframe used for the images below

See the open issues for a full list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

For now, this project is licensed under the MIT license. Please be respectful of my hard work and give me credit if you use my code.

See LICENSE.txt for more information.

Contact

Mary Elenius - [e-mail]

Project Links:

Wireframe

Github Repository

Deployment

Acknowledgments

I would like to give a big shoutout to my partner in crime and daughter, Yennefer! Every day she proves she is small yet mighty!

This app was built with heavy usage of D&D 5e API , the 5th Edition Dungeons and Dragons API. It is a simple api for things within the Official 5th Edition SRD and easily accessible through a modern RESTful API.