https://github.com/shap-po/guild-book
DnD Character Sheet Creator
https://github.com/shap-po/guild-book
angular dnd website
Last synced: about 2 months ago
JSON representation
DnD Character Sheet Creator
- Host: GitHub
- URL: https://github.com/shap-po/guild-book
- Owner: shap-po
- Created: 2024-02-14T08:09:50.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-31T18:55:22.000Z (about 2 years ago)
- Last Synced: 2024-12-28T04:47:36.719Z (over 1 year ago)
- Topics: angular, dnd, website
- Language: TypeScript
- Homepage: https://shap-po.github.io/guild-book/
- Size: 3.43 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Guild Book: DnD Character Sheet Creator and Sharing Tool
Guild Book is a tool designed for Dungeons and Dragons (DnD) enthusiasts. It allows you to create and share character sheets with ease. Each character is presented as a unique page in the guild book, making it easy to navigate and find the information you need.
This project is a proof of concept and was created as part of the internship program. It does not have all the features of a fully-fledged application.
## Visit the Site
You can view the deployed application [here](https://shap-po.github.io/guild-book/).
## Getting Started
### Prerequisites
Before you begin, ensure you have met the following requirements:
- You have installed the latest version of [Node.js and npm](https://nodejs.org/en/download/).
- You have installed [Angular CLI](https://github.com/angular/angular-cli). You can install it by running `npm install -g @angular/cli`.
### Running Guild Book Locally
To run Guild Book on your local machine, follow these steps:
1. Clone the repository to your local machine.
2. Navigate to the project directory.
3. Install the necessary dependencies by running `npm install`.
4. Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The application will automatically reload if you change any of the source files.
### Building the Project
Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory.
### Deploying to GitHub Pages
1. Run `ng deploy --base-href=/guild-book/` to deploy the project to GitHub Pages.
2. Navigate to `https://.github.io/guild-book/` to view the deployed application.