___bolderdash.js
A simple library of JavaScript functions used for common client-side tasks.
Using bolderdash
- Download
- Embed
<!-- Embed bolderdash.js -->
<script src="/path/to/my/vendor/scripts/bolderdash.min.js"></script>
<!-- Your Code After (of course) -->
<script type="text/javascript">
___.domReady(function () {
console.log('im using bolderdash. im bold af!!!');
});
</script>
Local Development Setup
Prerequisites
- Node 10.15.0+ (for local development, use nvm to install and utilize the appropriate version of node)
Setup Instructions
- Clone the repo.
git clone git@github.com:weareenvoy/envoy-bolderdash.git
OR
git clone https://github.com/weareenvoy/envoy-bolderdash.git
- Change to the project root directory.
cd envoy-bolderdash
- Run npm install.
npm install
Commands
-
Start the development server
npm run dev
This command will start a development server at http://localhost:3434, serving files from the
test
directory. -
Create a production build
npm run build
This command will build a production version of the framework for distribution. The production build is located in the
dist
directory.
Package Management
NOTE: Be sure to only use npm to manage packages in this project, NOT yarn or pnpm or any other package manager. We're using the Highlander Principle here. |
---|
Git Flow
When checking out a new branch, be sure to branch off of master
.
-
Create your new branch from
master
-
Use the following naming conventions:
- Feature branches:
feature/short-descriptive-title
- Hotfix branches:
hotfix/short-descriptive-title
- Feature branches:
-
Do you work on your newly created feature or hotfix branch and commit.
-
Push your branch to the remote repo and open a PR to merge into
master
. -
Add appropriate reviews.
-
Once PR is approved, merge and delete the branch from the remote repo.
-
Rinse and repeat.
Additional Info
Additional info here. (none at the moment)