search

MichaelWehar / Crossword-Layout-Generator

Crossword Layout Generator - Open Source
http://michaelwehar.com/crosswords
MIT License
56 stars 17 forks source link

prepare package creation #7

Closed mblaettler closed 4 years ago

mblaettler commented 4 years ago

To have the crossword generator available in bigger javascript projects it is helpful to add it to npmjs. This commit rewrites the code and adds files required for uploading and installing a package via npm. CAUCTION: This commit will break the index.html. It is required to use unpkg unce the node package is deployed.

Fixes #6

mblaettler commented 4 years ago

Hi @MichaelWehar

Like discussed in #6 I prepared everything for the package to be released on npmjs.

The following steps are required to publish it:

  1. Create a free account on npmjs
  2. Make sure you have installed npm. If not, follow this guide to install it.
  3. Run npm login and authenticate yourself with the login created in step 1.
  4. Check the package.json and change any fields you'd like (if you change anything run npm install afterwards to generate a new lock file)
  5. Run npm publish to publish the package on npmjs.

In case you have any troubles, feel free to contact me.

MichaelWehar commented 4 years ago

Woo hoo!! Thank you so much for doing this! :)

I'm sorry, I've been a bit busy finishing things up with final grading for the semester.

I'm hoping that I'll be able to review this in a couple days.

I hope that you have a Happy Holidays!

mblaettler commented 4 years ago

No hurry. I'm also quite busy due to the end of the semester and paused my project.

Enjoy your holidays!

MichaelWehar commented 4 years ago

Thank you again so much for doing this!

I am going to merge this into a branch called npm.

Next, I'm going to make some minor changes.

Then, I will give you an update and publish it to npm. :)

Hope that you have a Happy New Year!