elan.trybuch.com | Portfolio

🛡Badges

📋 Table of Contents

Acknowledgments
API Key & Documentation
Author
Best Practices
Build Setup
Documentation
Config
Contributing
Contributor(s)
How to use this module
License

ℹ️ How to use this module

clone this repo with the following command: git clone https://github.com/elaniobro/elan.trybuch.com
install all the npm modules with either yarn install
enjoy!

🚧 Build Setup

# install dependencies
$ yarn install

# serve with hot reload at localhost:3000
$ yarn dev

# build for production and launch server
$ yarn build
$ yarn start

# generate static project
$ yarn generate

# run tests
$ yarn test
#or
$ jest test

For detailed explanation on how things work, check out Nuxt.js docs.

** note: you may subsitute yarn for npm in the above commands **

🛠️ Config

coming soon

🔑 API Key & Documentation:

TBD

✅ Linting

This repo also has specific guidlines built into it, to help reduce the strain on code reviews. These rules are subject to change, but should ONLY be ammended through a pull request pending a code review. The files are also ran through a linter on staged files to verify that they adhere to the rules. You may run the command at anytime locally to check yourself.

yarn lint

🧪 Testing

This repo will check that all tests pass on any and all staged files prior to pushing. If you wish to test locally you may run the following command:

yarn test

⭐ Best Practice

Please name all git branches with a task ticket number.

$ git branch
* master
$ git checkout -b GIT-0-update-readme
Switched to a new branch 'GIT-0-update-readme'
$ git branch
* GIT-0-update-readme
  master

Please use the branch ticket number as a prefix for your commit(s), use the imperative voice and try to keep the title commit under 50 characters. This can be done when saying to yourself, "this commit will: your commit message here." replace the code block in the quote with the commit message

git commit -m "Update README.md with more sections"

The commit message should be short and to the point. You may be verbose and feel free to use any voice you wish, if you use a double commit message flag -m like so:

git commit -m "Update README.md with more sections" -m "I can now say whatever I want here, I can be as long as I like as well, since everything mentioned here, will fall under the ellipse when viewing this in git. and or fall under the long form log."

✨ Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue

👨🏻 Author

Elan Trybuch

github

🔃 Contributor(s)

⚖️ License

This project is licensed under the MIT License - see the LICENSE.md file for details

🙏🏽 Acknowledgments

📝 Documentation

Each component is also accompanied by a markdown file bearing the same filename as the component itself. These files can and should be auto generated via the CLI for vuesue. See the vuese documentation for how to properly comment props, events and methods.

Elaniobro / elan.trybuch.com