search

firebase / firebaseopensource.com

Source for firebase open source site
https://firebaseopensource.com
Apache License 2.0
118 stars 41 forks source link

Document the architecture and deployment steps (where possible) #38

Open samtstern opened 6 years ago

samtstern commented 6 years ago

slaps roof this bad boy can fit so many moving parts in it.

We should create some basic documentation so that when we forget how it works, we can remember. It's like The Notebook and @abehaskins is Rachel McAdams.

thatfiredev commented 5 years ago

I believe this would also help more people from the community contribute to this project. Maybe they would be able to fix the other issues we have here, so this one should probably be prioritized.

samtstern commented 5 years ago

If you want to mess with the frontend, that part is pretty simple:

$ cd frontend
$ npm install
$ npm run dev

Then you'll have a local server that will automatically rebuild and refresh on any changes. That said I guess you won't have any data ... I wonder if giving the real data set public readability is a terrible idea.

Also while it hardly counts as documentation, the Makefile gives some idea of what's going on with the backend: https://github.com/firebase/firebaseopensource.com/blob/master/Makefile

thatfiredev commented 5 years ago

@samtstern This is actually helpful. Thanks!