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

Boilerplate #13

Closed
marcustisater opened this issue Jan 1, 2016 · 26 comments
Closed

Boilerplate #13

marcustisater opened this issue Jan 1, 2016 · 26 comments
Assignees
Milestone

Comments

@marcustisater
Copy link
Member

Boilerplate to be started when #8 is completed. What I mean by boilerplate is to add things like well documented and thought out structured CSS, JS before we get to building.

Should we consider to use structure like BEM or just plain up components with CSS Modules etc...

Assignee: TBA Lead Developer to help out?

@marcustisater marcustisater added this to the Sprint 2 - Let's get to work! milestone Jan 1, 2016
@mxstbr mxstbr closed this as completed Jan 1, 2016
@mxstbr mxstbr reopened this Jan 1, 2016
@mxstbr
Copy link
Member

mxstbr commented Jan 1, 2016

Sorry, misclicked and closed the issue on accident.

I'd say let's go with components + CSS modules, it's the future and PostCSS fits perfectly with it.

@ai
Copy link
Member

ai commented Jan 1, 2016

Do not forget about all: initial and postcss-autoreset. Global reset and inherited properties is a problem too.

@MoOx
Copy link
Contributor

MoOx commented Jan 2, 2016

I can setup the boilerplate for Statinamic, that will help me review statinamic doc + enhance the setup command.
Note: Statinamic default boilerplate provides css modules.

@mxstbr
Copy link
Member

mxstbr commented Jan 2, 2016

@MoOx can we do it together/can you walk me through it? Haven't worked with Statinamic at all.

@MoOx
Copy link
Contributor

MoOx commented Jan 2, 2016

Here is a start http://moox.io/statinamic/docs/setup/
That should help.
I think I need to add more stuff based on a discussion with someone in reactiflux.
Meanwhile, if you want to try this now, feel free to ask all the question you got as Github issues in Statinamic repo for now :)

@mxstbr
Copy link
Member

mxstbr commented Jan 2, 2016

@MoOx Cheers, will take a look!

@marcustisater
Copy link
Member Author

Great, feel free to override README with documentation of how to to get Statinamic up and running locally once it's up.

@MoOx
Copy link
Contributor

MoOx commented Jan 2, 2016

"npm start" will be enough for local usage.

For "production" (build + commit to github pages - gh-pages branch) we will need to follow (once) instructions of statinamic docs to automate deploy on each commit pushed to master. I can help for that.

@mxstbr
Copy link
Member

mxstbr commented Jan 2, 2016

Let's do that and make master protected and only be committed into via PRs for safety.

If all you are going to do is the setup thing in the Statinamic docs, I can submit a PR as well.

@MoOx
Copy link
Contributor

MoOx commented Jan 2, 2016

Feel free to do it @mxstbr ;)

@marcustisater marcustisater removed this from the Sprint 2 milestone Jan 3, 2016
@marcustisater
Copy link
Member Author

Agreed @mxstbr that's already set to default. PR needs to be reviewed before merged into master.

@mxstbr can you setup the initial files to master then we can go from there with setting up more files and things like PostCSS if needed.

@MoOx
Copy link
Contributor

MoOx commented Jan 4, 2016

@mxstbr if you need assistance, do not hesitate to use Statinamic support (me haha). I plan to work on this project for the incoming weeks/months.

@mxstbr
Copy link
Member

mxstbr commented Jan 4, 2016

@marcustisater will do!

@MoOx thanks, if I run into problems I'll submit issues!

@mxstbr
Copy link
Member

mxstbr commented Jan 4, 2016

Very initial setup done, will take a deeper look tomorrow!

@MoOx
Copy link
Contributor

MoOx commented Jan 4, 2016

Do not hesitate to tell me how bad your experience was (because currently I think it's not really convenient...) and what we should improve. Feedbacks are important to me.

@marcustisater
Copy link
Member Author

Can someone double check this for me #16? Thanks.

@marcustisater marcustisater modified the milestone: 1.0 Jan 5, 2016
@mxstbr
Copy link
Member

mxstbr commented Jan 6, 2016

Need a better webpack config maybe

@MoOx
Copy link
Contributor

MoOx commented Jan 6, 2016

I think I will include postcss-cssnext in the default boilerplate but that won't be good for everybody.
Anyway, that's the power of statinamic: you define what you want/need.
Here is an example of another config https://github.com/putaindecode/putaindecode.io/blob/master/scripts/build.js

@marcustisater
Copy link
Member Author

Discussion from the meeting is to get the boilerplate ready before #12 is completed and also provide more documentation - #28

@mxstbr
Copy link
Member

mxstbr commented Jan 9, 2016

I think it makes sense to separate available layouts (e.g. Page, PageError,...) from more general React components (e.g. Button, Footer,...) by putting them in a separate folder.

I suggest we call the folder web_modules/pages for the layouts and web_modules/components for more general components.

routes was another option I was thinking about, but I'm pretty sure for beginners the connection between the URL and the component is clearer if the folder is called pages.

Thoughts? (Maybe worth including that separation in the official boilerplate @MoOx?)

@MoOx
Copy link
Contributor

MoOx commented Jan 9, 2016

What about this (I use it on a website and I like it)

  • web_modules/* for components
  • web_modules/layouts/* for layouts components ?

@mxstbr
Copy link
Member

mxstbr commented Jan 9, 2016

👍 I like it!

@mxstbr
Copy link
Member

mxstbr commented Jan 10, 2016

When #45 is reviewed and merged, this issue can be closed as the boilerplate setup is done for now. There will highly likely be small improvements over time, but the current state is enough for beginning to work on the actual site.

@marcustisater
Copy link
Member Author

Yup, sounds good. Nice work.

@marcustisater
Copy link
Member Author

Merged?

@mxstbr
Copy link
Member

mxstbr commented Jan 13, 2016

Oh yeah sorry, forgot to close the Issue!

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