|
| 1 | +# Client |
| 2 | +## Overview |
| 3 | +Stonhaven Academy is a white-label online learning platform. We have developed this platform to teach a person how to be a DnD Dungeon Master. The purpose of this project is to be able to develop a platform that is customizable for any learning path that a person or business needs. |
| 4 | + |
| 5 | + |
| 6 | +--- |
| 7 | +## Table of Contents |
| 8 | +- [Release Notes](##Release%20Notes) |
| 9 | +- [Dev Notes](##Dev%20Notes) |
| 10 | +- [Available Scripts](##Available%20Scripts) |
| 11 | +- [Learn More](##Learn%20More) |
| 12 | + |
| 13 | +--- |
| 14 | +## Release Notes |
| 15 | +### Build Status: |
| 16 | + |
| 17 | +[](https://app.netlify.com/sites/stonehaven-academy/deploys) |
| 18 | + |
| 19 | +### Current Release: |
| 20 | +Pre-Alpha (0.0.0) |
| 21 | + |
| 22 | +### Release Details: |
| 23 | +<!-- #### Upgrade Steps --> |
| 24 | +<!--Includes: |
| 25 | + - Steps users have to take when they upgrade beyond just dumping the dependency. |
| 26 | + - Pseudocode that highlights what code should change and how. |
| 27 | + - Call out if users are recommended to upgrade because of known problems with older releases. --> |
| 28 | + |
| 29 | +#### New Features |
| 30 | +<!-- Includes: |
| 31 | + - the new feature |
| 32 | + - when/why to use it |
| 33 | + - pictures! |
| 34 | + - caveats/warnings? |
| 35 | + - Is it a beta feature? --> |
| 36 | +- Lesson Page |
| 37 | + - List of Lessons in current course |
| 38 | + - Cycle through lessons with next/prev buttons |
| 39 | + - Youtube Credits |
| 40 | +- Support Page |
| 41 | + - FAQ |
| 42 | +- Feedback |
| 43 | + - Link to Google Forms feedback |
| 44 | + |
| 45 | + |
| 46 | +#### Bug Fixes |
| 47 | +<!-- Includes: |
| 48 | + - existing feature/functionality that now works as intended or expected.--> |
| 49 | +- No bugs... |
| 50 | + |
| 51 | +#### Improvements |
| 52 | +<!-- Includes: |
| 53 | + - Improvements/enhancements to a: |
| 54 | + - workflow, performance, logging, error messaging, or user experience --> |
| 55 | +- No feedback... |
| 56 | + |
| 57 | +--- |
| 58 | +## Dev Notes |
1 | 59 | ### Naming conventions: |
2 | 60 |
|
3 | 61 | - **Classes/Components**: Pascal case (e.g. `HomePage.js`) |
|
11 | 69 |
|
12 | 70 | We are using VSCode for development with the ESLint and Prettier extensions for consistency. Configuration files for both extensions are included in the root of this repository. If contributing, please either install those extensions or read through them and ensure your code complies with the rules listed. |
13 | 71 |
|
14 | | ------------------------------- |
| 72 | +### Library |
15 | 73 |
|
16 | 74 | This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). |
17 | 75 |
|
| 76 | +--- |
18 | 77 | ## Available Scripts |
19 | 78 |
|
20 | 79 | In the project directory, you can run: |
@@ -52,6 +111,7 @@ Instead, it will copy all the configuration files and the transitive dependencie |
52 | 111 |
|
53 | 112 | You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it. |
54 | 113 |
|
| 114 | +--- |
55 | 115 | ## Learn More |
56 | 116 |
|
57 | 117 | You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). |
|
0 commit comments