Skip to content

This is the new home of Hey Rebekah's insane next.js app in partnership with our friends at Web3Templates

License

Notifications You must be signed in to change notification settings

brilla-cx/hr-web

Repository files navigation

Welcome to Hey Rebekah's Composable Content Cloud ☁️

Maintainability Test Coverage

About Us 📚

Welcome to Hey Rebekah! Picture us as your daily shot of espresso — sharp, exhilarating, and potentially lifesaving, especially for those Monday mornings.

We're a free daily newsletter for those professionals who've reluctantly acknowledged the new tech-whiz on the block — AI. Think of AI as the charismatic, perpetually present relative who's just moved in next door. You can't ignore them, so you might as well learn how to get along.

Project Objectives ⚙️

In true Hey Rebekah style, we've decided to tackle the chaos of our own backyard before preaching order to the world. This project is about streamlining our publishing workflow.

Picture a clean, efficient conveyor belt that zips our freshly minted content straight to your digital doorstep.

Our main job? Cracking our knuckles and diving into crafting thought-provoking content that stands out in your daily news avalanche.

Our tech team's job? Smoothly delivering these pieces to our bustling community of over 338,000 members across various platforms. This way, we stay true to our mission — to make knowledge free.

Our Toolbox 🛠️

Development Stack

  • PNPM - The swift package management we rely on.
  • WunderGraph - The Backend for Frontend framework that keeps our developer workflows neat and tidy.
  • TypeScript - Adds the necessary discipline to our JavaScript.
  • Sanity.io v3 - Organizes our content just right.
  • Next JS 13 - The heart of our React Framework.
  • Clerk.com - Manages our user interactions without breaking a sweat.
  • TailwindCSS - Our CSS framework that doesn't skimp on utility.
  • Tailwind UI - Our library of choice for components.

Frameworks & Libraries

Deployment and Monitoring

  • Vercel - The silent hero of our deployment saga.
  • CodeClimate - Our go-to for keeping our code clean and polished.
  • Checkly - Keeps a watchful eye on our web application monitoring and testing.

Additional Integrations & Tools

  • Slack - The bustling hub where our team chatter resides.
  • Height App - Our reliable work management system.
  • Iterable.com - Our choice of platform for all things email.
  • Recombee - Our tool for machine learning and content recommendations.
  • Make.com - For creating low-code API connections in the cloud.

Embracing TypeScript: The New Neighbor We Can't Ignore 🏘️

Just like in any community, new members show up and shake things up a bit. In our digital cul-de-sac, TypeScript has been that quirky, precise new neighbor who's not just passing through. With a love for strict rules and meticulous organization, TypeScript has moved into about 55% of our homes in the codebase neighborhood. It's been a rollercoaster, a block party of growth and adaptation. We're not yet the fully-disciplined, TypeScript-dominated community, but we're getting there, and boy, isn't it an adventure!

Test Coverage: The Big Bash We've Always Promised 🎪

Remember that grandiose neighborhood block party we've always promised but never actually threw? That's our current test coverage. Think of it as the vast open space we've earmarked for the party — brimming with potential, but for now, glaringly empty. But, as with any big promise, we're set on making it happen. We're looking to transform this barren plot into a bustling carnival of extensively-tested code. Watch this space, because our "Block Party Coming Soon" banner is going up soon!

Accessibility: Our Neighborhood's Code of Conduct 👀

In our little content town, inclusivity and accessibility aren't just polite suggestions, they're part of our community code of conduct. It's our commitment to make sure our digital streets are not only user-friendly, but welcoming to all, no matter their preferred mode of transport. Be it mouse, keyboard, screen reader, or another assistive tech, we're dedicated to consistently improving our town planning to offer an inviting experience to all. It's not perfect, but it's getting better. After all, what's a community if not welcoming to everyone?

Into the Future: The Town Planning Committee 🏗️

Here's a big round of applause for Web3Templates. They've been the supportive town council in this urban development journey. But like town folks hankering for a new dog park or a cozy café, we're itching for some fresh scenery. That's why we're sketching out blueprints for a custom component library, architectured with RadixUI and shadcn/ui, all stylishly landscaped with TailwindCSS.

And because we firmly believe that growth is the name of the game (and we love a good challenge), we're also transiting to a Vercel Turbo repository. The grand occasion? We thought it's about time to extend our community borders by welcoming our iOS and Android apps into the mix. A little more chatter and liveliness, right? Sure, it's going to add some complexity to the mix - but isn't that the spice of communal life? Here's to future renovations, animated town hall meetings, and of course, lots of shared laughter and learning!

Be a Part of Our Civic Project ⁉️

Ready to get your hands dirty with some civic duty? The following instructions will get you set up for development and testing purposes. Get ready to roll up your sleeves and become part of our vibrant community's evolution!

Prerequisites

Before you roll up your sleeves, ensure you have the following tools in your toolbox:

Installing

  1. Clone the repository:
git clone https://github.com/brilla-cx/hr-web
  1. Change to the project directory:
cd hr-web
  1. Install the dependencies using PNPM:
pnpm install

Testing

To run the tests:

pnpm test

Deployment

To deploy the application, follow these steps:

  1. Sign up for a Vercel account if you haven't already.
  2. Install the Vercel CLI and log in with your account.
  3. Run the following command from the project directory:
vercel
  1. Follow the prompts to deploy your application.

Contributing 🤝

We're always looking for contributors to help improve the project! If you're interested in contributing, please follow the steps below:

  1. Fork the repository
  2. Create a new branch (git checkout -b feature/YourFeatureName)
  3. Commit your changes (git commit -m 'Add your feature')
  4. Push your branch to your fork (git push origin feature/YourFeatureName)
  5. Open a pull request

Versioning 📊

We use SemVer for versioning. For the available versions, see the tags on this repository, once they're available that is.

Authors ✍️

  • Surjith the Great - Web3 Template Creator - surjithctly
  • Samuel the Ambitious - Protostar Developer - samuelwondimu
  • Sam the Reluctant - Cat herder - srizvi

Also, see the list of contributors who participated in this project.

License 📄

This project is licensed under a modified MIT like License subject to the specified conditions - see the LICENSE file for details.

Toast to our Influences 🙏

Cultivating a content neighborhood isn't about merely zoning out blocks and delegating tasks. It's about kindling a collective dream for the limitless potential of the digital metropolis.

In this spirit, our neighborhood isn't just a construction - it's a labor of love. Our inspirations are as varied as they are meaningful:

  • The principles of architecture have served as our masterplan, illuminating our path through the boundless expanse of the digital cityscape.
  • Accessibility has been our town charter, ensuring our roads and alleys are accessible to all, regardless of their mode of transportation.
  • The shadcn and RadixUI blueprints have been our architectural playbook, guiding us through the ever-evolving cityscape of frontend development.
  • Juno, the neighborhood's favorite furry mascot, has been a loyal companion, offering joyful romps and welcome distractions.
  • Our readers, our true community stakeholders, for whom we build and develop our digital township, continuously inspire us to push the city limits and delve deeper.
  • And finally, our impeccable taste has been our urban planner, charting a path through infinite possibilities towards a district of novelty and excellence.

To everyone who's taken part in this communal growth, either by contributing code, sharing insights, or just cheering from the sidelines: We raise our construction helmets to you. Thanks for joining us in our wonderment at the boundless landscape of the digital metropolis.

Deploy on Vercel

You can easily deploy this project on Vercel by clicking the button below:

Deploy with Vercel