Waifu.it Documentation

Getting Started

Install dependencies,

$ npm i

Start the dev server,

$ npm run dev

Build documentation,

$ npm run build

Contributing

All contributions are greatly appreciated, but I recommend creating an issue or replying in a comment to let me know what you are working on first that way we don't overwrite each other.

Please read CONTRIBUTING.md for details on this project.

Issues

• Feature requests/enhancements
• Bug reports
• Questions/feedback

Branches

• production -> don't touch, this is what's running in production

• staging -> pull request this branch for everything

Pull Requests

All pull requests are welcome!

• Fork the repository on GitHub.

• Clone the forked repo to your local machine.

• Do you changes

• Commit your changes

• Push your changes back up to your fork.

• When you're ready, submit a pull request so that we can review your changes.