rollerderby / crg

CRG Scoreboard and Game System
GNU General Public License v2.0
8 stars 3 forks source link

Restructure front end #1

Open baconbrad opened 8 years ago

baconbrad commented 8 years ago

We had a brief conversation on Facebook this morning about restructuring the front end. Then @mmitton and I discussed it a little in a PM.

The current goal is to make the front end a little more developer friendly. And the end user code bandwidth friendly.

What we are leaning towards is creating a client directory. Our code for the front end will rest in there. In it will be a package.json. This will have all our third party front end dependencies listed, our dev dependencies, etc. Devs who wish to maintain the client will need to install Node.js and run npm install. Running say npm run build or something like it could build the source and put a distribution version in the root of the client. Doing this we can minify the source, make tests, lint, etc. And the source will be restructured to be easier to maintain in an editor and we can have some automated quality control of the client.

Both the source and distribution will be provided on the repo. Minus the node_modules directory which contain the unbuilt dependencies.

The html directory is being untouched for the current time. Until we make this transition completely. Afterwords it will be removed and you would develop out of client/src and your source will build to client directory.

The only changes on the server side would be path changes. And the end users would only notice path/file changes and nothing would be different for them.

If anyone has any objections, suggestions, changes, etc to this plan please feel free to comment.

baconbrad commented 8 years ago

Todo: build.sh

baconbrad commented 8 years ago

Todo: Client Views

baconbrad commented 8 years ago

Todo: Scripts and Styles

baconbrad commented 8 years ago

Todo: Third Party Dependencies