Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean Up Repo Commit Process + Make a Crossplatform Build Script #35

Closed
Skylion007 opened this issue Jun 9, 2016 · 11 comments
Closed

Comments

@Skylion007
Copy link
Collaborator

Currently, when you submit a change to the repository, you must first modify the individual source files, then run the build script, then copy the newly built script to the www folder. This is terribly inefficient and each change can become 23MB or more! We are also in desperate need of defining a style guide and documentation for committing to the repository.

@zaerl
Copy link

zaerl commented Jun 9, 2016

I can help the maintainers with this problem. I think that you should use one of the popular building tools like gulp, grunt or whatever and npm for managing all the dependencies. The www folder IMHO can be moved to a separated branch.

@Skylion007
Copy link
Collaborator Author

Skylion007 commented Jun 10, 2016

I definitely agree that www should be moved to a separate branch, although probably not to "gh-pages" since I think we still wish to use Brown University as our webhost.

I don't have a lot of experience with JS build systems so I am not sure whether Gulp or Grunt would work better for this project, but anything would be better than the SH build script we currently employ. We also have another issue for wrapping this project as an NPM module, so also feel free to help out with that as well.

I think we can take care of moving the www to a demo branch, if you wish to work on getting a build system setup.

Update: It looks like Gulp might be the best solution from what I am reading. Also feel free to give a shot at issue #26.

@zaerl
Copy link

zaerl commented Jun 10, 2016

Nowadays gulp is by far the most used task runner and it's an excellent choice. I can enclose the project on an NPM module but you have to register it on npm central repository.

@Skylion007
Copy link
Collaborator Author

We'd be glad to register the module on the NPM central repository.

@alexpapster
Copy link
Collaborator

www contents were moved to a new branch (www)

@jeffhuang
Copy link
Contributor

That's a little unusual in using branches as a separate storage for www files. I think it's more common to put it in a separate repository.

@alexpapster
Copy link
Collaborator

alexpapster commented Aug 3, 2016

If you'd like to you can create under brownhci a separate repository and we can put it there. I don't mind as long as www doesn't come with the master branch of webgazer.

@jeffhuang
Copy link
Contributor

Doesn't matter to me that much. What do you want to do?

@alexpapster
Copy link
Collaborator

I prefer it as it is, it's very fast and easy to manage, although not very conventional. Unless anyone has an alternative suggestion let's leave as it is, at least for now.

@Skylion007
Copy link
Collaborator Author

@zaerl I found a Grunt file that I modified to suit our build needs for now, a Gulp build system might be better down the line but for just concatenation and uglification, this seemed the easiest. Still open to a Gulp build system to complement the Grunt one.

@jeffhuang
Copy link
Contributor

think this one can be considered resolved

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants