README.md

Hive

It is an open source social media management platform for content creators. It brings different social media platforms and services together to create a unified experience for content creators. It brings all the stats of different social media platforms in one place which helps them better understand their audience and make content that matters to them to increase audience engagement and growth of the creator

For participant's manual visit: Mentee's Guide

Join our Discord Server to interact with the maintainers and community

Project Aims

UI

• Link for figma Prototypes Click Here

For Backend

1. Having a single backend that serves both the web client and the mobile app.
2. Backend should be made of Node.js with Express.js.
3. Database is MongoDB.
4. For caching purposes use Redis.
5. Code should be scalable from the start.
6. We will use middleware based approach for all the routes.
7. Factory design pattern is used for handling the success response and error responses so that a standard template can be maintained over all the routes.
8. We will maintain the API documentation usign Swagger and Swagger UI.

For Frontend

1. Web client uses React.js with create-react-app and mobile app uses React Native.
2. UI should be responsive for the web client keeping a mobile first approach.
3. For both web and mobile app in the UI utmost priority should be given to accessbility and intuitiveness for all the functionalities of the app resulting in better UX.

Links to related content for learning

Backend

• Node JS Design Patterns: https://blog.logrocket.com/design-patterns-in-node-js/

Frontend

• React JS Design Patterns: https://blog.logrocket.com/design-patterns-in-react-js/
• Create-react-app: https://facebook.github.io/create-react-app/

For contributing to the repo see Contributing Guidelines

This file has been changed please go through the updated guidelines to make your PRs count (for contributions coming under JWOC specially)

Getting started with your first contribution to Open-source

The prerequisites you need to have are:

1. Vscode
2. git
3. Basic understanding of Integrating git and GitHub : Please_refer

If you don't have Vscode on your machine, install it. If you don't have git on your machine, install it.

Fork this repository

Fork this repository by clicking on the fork button on the top of this page. This will create a copy of this repository in your account.

Clone the repository

Now clone the forked repository to your machine. Go to your GitHub account, open the forked repository, click on the code button and then click the copy to clipboard icon.

Open a terminal and run the following git command:

    git clone "url you just copied"

Create a branch

Create a branch using the git checkout command:

    git checkout -b your-new-branch-name

Make changes and commit

To run the project in your local machine see: Contributing Guidelines

Now that your project is up and running through the desired port : usually localhost:5000 for the Server localhost:3000 for the Website start making the required changes.

Make the nessecery changes and commit them using the git commit command:

    git add .
    git commit -m "your commit message"

Push the changes to the remote repository

To push the changes to the remote repository, use the git push command:

    git push origin <your-new-branch-name>

Submit your changes for review

If you go to your repository on GitHub, you'll see a Compare & pull request button. Click on that button.Now submit the pull request.Woof You just made a PR!!

ONLY 4 Steps to get you there

1. fork
2. clone
3. add and commit
4. compare and Pull request

Where to go from here?

Congrats! You just completed the standard fork -> clone -> edit -> pull request workflow that you'll encounter often as a contributor!

Now let's get you started with contributing to the project.

For Security realted things see Security Policy

To work in this repo you need to adhere by this Code of Conduct