Nikhil1912 / Athenaeum

MIT License
0 stars 1 forks source link

Create GitHub page for documentation #43

Open hreiche opened 2 years ago

hreiche commented 2 years ago

https://github.com/reactjs/react-docgen https://medium.com/@whoisryosuke/automating-react-documentation-using-react-docgen-%EF%B8%8F-3e1b2e2b0c0b

2 options for automatic documentation in React

hreiche commented 2 years ago

https://dev.to/yuribenjamin/how-to-deploy-react-app-in-github-pages-2a1f

think this might also be a good idea

Nikhil1912 commented 2 years ago

Will the app even work? I don't think we'll have the backend running for it to function.

hreiche commented 2 years ago

Unsure. I looked up whether we could have a react/django application hosted on GitHub pages, and it seems the answer is no. It may well be worth still having something that interacts with our react app though, which I found at least one tutorial for.