README
Text-ile is a tool developed to help artists visualize text-based patterns on receipt paper.
Running locally
To work on the code locally, you can use any text editor you normally use to work with JavaScript (VSCode is what Nikki uses). As we have been testing various libraries and modules, we've encountered some CORS errors. The fastest way around this is to view the project from a local server.
Contributing
(basic intro)
In VSCode, you can install the "Live Server" extension. Starting a live server will sidestep any CORS issues.
Contribution Workflow
- Once you've found an issue to work on.... (see next section)
- Assign that issue to yourself so that everyone knows you're taking it
- Click on the "create a branch" link in the issue. All of your code for the issue will go onto that branch.
- (write code!)
- When you're done, make sure all of your code is committed to your branch and pushed to origin.
- Open a pull request, explain your changes, and assign the PR to Nikki
Documentation
To Generate jsdocs
Documentation is contained in-code and generated by jsdocs. To generate fresh docs, from the projct root:
./node_modules/.bin/jsdoc -c jsdoc.conf.json -R README.md -r .Code of Conduct
Contribution Guide
License
Contributors
 Michael Crockett 💻 📖 🚇 |
 LeoBueno15 💻 🎨 |
 mollyinkilos 💻 🎨 🤔 |
 Wei 💻 🎨 |