chrisjm / openbrewerydb-website

Open Brewery DB website with brewery search React app (Deprecated)
https://www.openbrewerydb.org/
MIT License
15 stars 14 forks source link

Convert site to GatsbyJS with GitBook Starter Theme #8

Open chrisjm opened 6 years ago

chrisjm commented 6 years ago

Describe the solution you'd like https://www.gatsbyjs.org/starters/hasura/gatsby-gitbook-starter/

717df732cb277eb8d8e990a819ce3c28

tristandenyer commented 6 years ago

My first question would be "Why are you using React for the search form?" Could you just use vanilla JavaScript?

I ask because, as the site is now, it seems a bit overkill to use React for a one-pager that only has one form field. Asking a user to download a large .js file just to view what is basically a small, light-weight experience seems a lot.

I could see using React if it's something you are looking to learn it, and or the site is going to get to be multi-page and adding in more functionality.

We used React and Gatsby at work for our documentation pages because we were documenting our React component library. I do remember hearing that Gatsby took some wrangling to working well to render examples of our React components (which seemed odd to me.)

If React is the route you are looking to take, maybe Next.js could work? They make code splitting an out-of-the-box feature, which could help keep the initial .js bundle smaller, and lazy-load the rest of the app as-needed. Sounds like it comes with some other features intended to make React apps easier to implement (I have yet to use it.)

Whatever you choose, I would be stoked to help out where I can! (I can always stand to learn more React/SPA, Node and whats-hot-now.js).

chrisjm commented 6 years ago

My first question would be "Why are you using React for the search form?" Could you just use vanilla JavaScript?

Fair points.

I wanted to practice React, so that's the only reason for the search form. Plus, I figured it's a good resource to see a "proof of concept" along with the code. Perhaps the example should be called out more or put into it's own repository. 🤔

Yes, I do imagine the site could expand beyond just one page, but perhaps we wait until it's necessary. Let's put this on the back-burner until it's ready.

@tristandenyer If you wanted to work on a plain JS version of the search form, feel free to create an issue and start hackin'! Let me know if you have any questions.

Thanks for contributing!

chrisjm commented 5 years ago

I'm re-opening this issue. After a year (in fact, exactly a year. Woah! 😳) GatsbyJS is in a much better place and I like this documentation-based Gatsby starter theme:

https://www.gatsbyjs.org/starters/hasura/gatsby-gitbook-starter/

tristandenyer commented 5 years ago

We are just now finishing up a Gatsby v2 site and have to say that it has definitely matured. Still some growing pains with adding simple JS scripts. The gitbook starter is a great one. I looked at dozen or so and that was top of my list.

teisenhower commented 5 years ago

Hey @chrisjm! First want to say I love this API. I am working with it currently to make a personal Node.js app. Once I have that further along I would love to share that with you.

I'd love to be an asset somewhere if possible. I signed up for the newsletter a few months back but wanted to reach out directly as well. I don't know much about Gatsby but would be willing to take a swing at it. My comfort level is more back-end work.

If there is anything now or in the future you want to outsource I'd love to help.

Thanks!

chrisjm commented 5 years ago

Hi, @teisenhower ! The project and community would love your help!

I might hammer out the Gatsby site soon just to get it live, but it will need constant updates and improvements.

If you're more comfortable with the back-end stuff, check out the API server projects:

https://github.com/chrisjm/openbrewerydb-rails-api https://github.com/chrisjm/openbrewerydb-serverless-api (work in progress)

Let me know if you have any further questions and I'll be reaching out via the newsletter soon.

Cheers! 🍻

chrisjm commented 5 years ago

Created new repo: https://github.com/chrisjm/openbrewerydb-gatsby

Go to the new repo for more updates.

teisenhower commented 5 years ago

@chrisjm

Thanks! I'll be sure to take a look at those as well.

Thanks again!