/the_monkeys

Blog Together Write Better - Don't let outdated blogs overshadow your ideas.

Primary LanguageTypeScriptApache License 2.0Apache-2.0

Monkeys

The Monkeys: Seamless Creation, Effortless Collaboration

Unleash Your Creativity and Influence: Blog Together, Write Better

Welcome to The Monkeys, your go-to educational and informational blogging platform!

At The Monkeys, we provide a dynamic space for individuals to share their knowledge and experiences across a wide array of topics. Whether you're passionate about science, technology, personal development, self-improvement, psychology, philosophy, fashion, health, or lifestyle, you'll find a place here to both learn and contribute.

Our platform is designed with the belief that learning should be accessible to everyone. Dive into our diverse range of perspectives and insights, and expand your understanding of the world.

We also believe in the power of community. Engage with fellow readers, writers, and experts. Share your thoughts, offer feedback, and join the conversation. Your voice matters here, and together, we can create a vibrant and enriching environment for growth and learning.

Explore, learn, and grow with The Monkeys. We're excited to have you on this journey with us!

Project Roadmap

  • Shift the codebase from React.js to Next.
  • Initial project setup.
  • UI/UX design (v1).
  • Landing page.
  • Authentication service.
  • User service.
  • Blog service.

Installation

  1. Clone & create this repo locally with the following command:
git clone https://github.com/the-monkeys/the_monkeys.git
  1. Install dependencies using npm:
npm install
# or npm install --force
  1. Copy .env.example to .env.local and update the variables.
cp .env.example .env.local

  1. Input all the required enviroment variables in .env file.

  2. Start the development server:

# At the root of the repo
npm run dev

Tech Stack & Features

  • Next.js – The React Framework for the Web.
  • Netlify – Netlify is the essential platform for the delivery of exceptional and dynamic web experiences, without limitations.
  • Next Auth – Add authentication to your next app in minutes.
  • Zod – TypeScript-first schema validation with static type inference.
  • Tailwind CSS – A utility-first CSS framework packed with classes that can be composed to build any design, directly in your markup.
  • Shadcn/ui – Beautifully designed components that you can copy and paste into your apps.
  • Remix Icons – Open-source neutral-style system symbols elaborately crafted for designers and developers.

Backend

The backbone of The Monkeys platform is powered by a robust backend written in Go, housed in our dedicated repository.

For those interested in exploring the architecture of our backend, or looking to contribute, we invite you to visit the repository. Dive into the code, understand the intricacies, and join our community of developers in enhancing the platform. Your contributions are invaluable in making The Monkeys a richer, more dynamic space for everyone.

Backend repo: The Monkeys Backend

Guidelines

To ensure smooth collaboration and maintain the quality of contributions, we have established some guidelines for raising issues and submitting pull requests (PRs). Please adhere to the given formats to help us address and integrate your contributions more efficiently.

1. Raising an Issue

When raising an issue, please follow the specified format provided in our repository. This helps us understand and resolve the problem quickly.

2. Submitting a Pull Request (PR)

When submitting a pull request, ensure you follow the provided format outlined in our repository. This helps us review and merge your changes effectively.

3. Taking an Issue

To claim ownership of an issue, comment .take on the issue thread. This will assign the issue to you, allowing you to work on it. Please ensure that the issue is not already assigned or in progress before claiming it.

By following these guidelines, you help maintain a high standard of collaboration and development on The Monkeys platform. We appreciate your cooperation and contributions!

Contributing

We are thrilled to have you consider contributing to The Monkeys! Our platform thrives on the diverse knowledge and skills of our community.

Whether you're an experienced developer, a tech enthusiast, a writer, or someone passionate about sharing insights, there's a place for you here. Here are a few ways you can contribute:

  1. Code Contributions: Help us improve and expand our platform. From fixing bugs to adding new features, your code is valuable.
  2. Documentation: Good documentation helps everyone. Contribute by improving our existing docs or adding new ones.
  3. Community Engagement: Participate in discussions, offer feedback, and help fellow contributors with their queries.
  4. Content Creation: Share your expertise by writing articles, tutorials, or creating video content about various topics covered on The Monkeys platform.
  5. Feature Suggestions: Have an idea for a new feature or an improvement? Share it with us and collaborate on bringing it to life.

Every contribution, big or small, makes a difference. Join us in making The Monkeys an even better resource for everyone. We look forward to collaborating with you!