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

refactor : done and todo #114

Open
9 of 14 tasks
tmos opened this issue Jul 4, 2016 · 2 comments
Open
9 of 14 tasks

refactor : done and todo #114

tmos opened this issue Jul 4, 2016 · 2 comments
Milestone

Comments

@tmos
Copy link
Collaborator

tmos commented Jul 4, 2016

Hi everyone

I'm currently doing a big refactor on MiniGal. It need like a lot of cleaning, and now is the time. Some changes will probably bother more than one people, but it will definitely allow MiniGal to be more accessible and, moreover, much more modern, in a code point of view.

Don't worry, KISS is still here, nothing changes more than the dirty old code !

So don't except new features with the refactor itself. But this refactor will allow new features to be done much easier and faster. #44, #32, #111, #112, #113 are in my mind ! I plan to beat down every issue after the refactor 💪 .

So, here is what I'm doing, and what is still to be done. I don't expect any help, I'm really close to the end, but if you see anything worth discussion, don't hesitate :)

General direction

  • index.php just return raw data to the template, no processed HTML. More freedom for the templaters, and more flexibility.
  • clean all the code, remove undeclared variables, uniformisation of the style, php linting, etc.
  • Make templates more independent, allowing them to have their own dependencies, so everyone is able to craft his own theme (with, without lightbox, jquery, bootstrap, etc.).

Theme

  • Switch from HTML with fake templating system <% ... %> to PHP native inline templating abilities <?php if (...) : ?> <?php foreach (... as ...) : ?>.
  • Adapt the templates to the new returned data from index.php

Board default theme

  • Modern frontend workflow (gulp, linting, less, etc.)
  • Let's go to 2016 modern standards, and drop some old browsers (flexbox, vh, etc.)
  • Modern libraries (custom fontawesome, bootstrap grid (just the grid, not everything), jquery 3).
  • Full CSS & JS minification
  • Better SEO (meta description, alt, unique content, etc.)

For information, the default Board theme will become a little bit more complex to edit (due to gulp and less), but this will be much more efficient in a coding point of view, and cleaner. So to allow people to keep their old customizations, a Board-legacy theme will be shipped, with minimal modifications from the 0.4 and instructions to keep your modifications online :)

So you may ask : what still need to be done ?
Actually, just the regular gravels in MinigalNano's shoe :

  • Lightbox (I'll finally do this myself, no lib, old school)

And We will be ok for the .5 of minigal !

And plans for the future :

  • Proprotional pictures cropping
  • Proper translating system (csv, po, ... ?)
  • Better comments system, allowing to add more data to the pictures (title, desc, link, alt, title, etc.) through a CSV-like file. But nothing planned yet.

All of this is already online in the refactor branch, don't hesistate to have a look :)

@tmos tmos modified the milestone: 0.5 Jul 5, 2016
@MaraKat
Copy link

MaraKat commented Jul 21, 2017

Hello !
And thank you for your commit.
What is the use of the node modules ? Are they only as help to make templates ? What will happen if I do not upload them ? Are some of them absolutely necessary ?

@tmos
Copy link
Collaborator Author

tmos commented Jul 23, 2017

They are here just for the developpement, no need to be uploaded for production if I remember well :)

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

No branches or pull requests

2 participants