Welcome to the repo! Storyden is a pet-project of mine which has been in the works somewhat stealthily for about a year.
My goal is with open source contributions is to treat Storyden as a place to learn, improve skills, challenge ideas and most of all, have fun!
General topics you'll encounter in this project
Golang service: it's a fairly large codebase with lots of production-grade patterns based on my decade experience with the language, but there are always areas to improve!
OpenAPI specification-driven development: all the boring stuff uses code-generation to get features shipped faster, the specification is the heart of Storyden's API contract.
Next.js frontend: I try to make use of the latest Next.js features and patterns and Storyden acts as a sort of demo for most Next.js features.
swr (stale-while-revalidate) Storyden makes use of this pattern a lot in the frontend, it does introduce complexity with a tradeoff of great instant-feedback user experience
Server side rendering: the aim is to build a social content management system that's SEO and accessibility friendly, all read-first pages (pages where interactivity is not the primary function) are server-side rendered.
TypeScript: the frontend codebase is written in TypeScript, with a balance between simple useful types and complexity where needed.
Hacktoberfest
There are some issues that have a "Hacktoberfest" tag or "Good first issue" if you're interested in experimenting, hacking, implementing, helping or just learning please @ me if you have any questions of want any guidance. I'm happy to do screen sharing sessions and pair-programming on the https://makeroom.club Discord server too.
The concepts and design of Storyden's codebase is not fully documented yet and while I try to highlight the more complex areas with (often lengthy) code comments, documentation is, as always, an ongoing effort. If you find some areas of the code intriguing or confusing and either wish to learn more or write up your understanding as documentation, please file an issue!
Happy hacking, and thank you for contributing to this forever-open-source project!
Welcome to the repo! Storyden is a pet-project of mine which has been in the works somewhat stealthily for about a year.
My goal is with open source contributions is to treat Storyden as a place to learn, improve skills, challenge ideas and most of all, have fun!
General topics you'll encounter in this project
Hacktoberfest
There are some issues that have a "Hacktoberfest" tag or "Good first issue" if you're interested in experimenting, hacking, implementing, helping or just learning please @ me if you have any questions of want any guidance. I'm happy to do screen sharing sessions and pair-programming on the https://makeroom.club Discord server too.
The concepts and design of Storyden's codebase is not fully documented yet and while I try to highlight the more complex areas with (often lengthy) code comments, documentation is, as always, an ongoing effort. If you find some areas of the code intriguing or confusing and either wish to learn more or write up your understanding as documentation, please file an issue!
Happy hacking, and thank you for contributing to this forever-open-source project!