Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sreehari2003/buzznet

A social media Demo - Internship Task for carestack.com
https://github.com/sreehari2003/buzznet

expressjs jwt monorepo nextjs nodejs reactjs social-media social-network typescript

Last synced: 7 days ago
JSON representation

A social media Demo - Internship Task for carestack.com

Awesome Lists containing this project

README

        

[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]




Buzznet


Internship task for carestack



Buzznet is a opensource social media platform for peoples to find friends online.
our featues include search for friends , send friend request etc





Table of Contents



  1. About The Project



  2. Getting Started


(back to top)

## video explanation

https://user-images.githubusercontent.com/66205494/226189526-b6d626e3-b129-4fc5-9b5c-94da31cbc0f7.mp4

## Features

- user can create account
- user can login
- user can update profile
- user can search peoples
- user can send friend request
- user can accept request
- user can see mutual friends

### Built With

- [React Js](https://reactjs.org/)
- [Next Js](https://nextjs.org/)
- [Express Js](https://nestjs.com/)
- [Typescript](https://typescript.org/)
- [MongoDB](https://typescript.org/)

(back to top)

```
project structure/
├── apps/
│ ├── api/package.json
│ └── web/package.json
├── tsconfig
└── package.json
```

## AIM

Create a mini social network. The application should have features like:-

· Users should be able to sign up/sign in, and create a profile for themselves.

· Search for other users.

· View other users' profiles & make them friends/unfriend them.

· View a list of mutual friends between users. A mutual friend is a user who is a friend of two other users who may or may not know each other.

### Api users response example

### Prerequisites

You need to install

1. [Node v16](https://nodejs.org/en/)
2. [pnpm](https://pnpm.io/)

### Installation

1. Clone the repo

```sh
git clone https://github.com/sreehari2003/Buzznet
```

2. Install all the NPM packages all the applications.

> We are using pnpm and turborepo to manage the applications in monorepo.

```sh
pnpm install
```

3. Copy the `.env.example` for each applications to `.env` in the same directory and fill the values required

4. Start the web application dev server and open `http://localhost:3000`

```sh
pnpm --filter web dev
```

5. Start the api server and open `http://localhost:8000`

```sh
pnpm --filter api dev
```

(back to top)

## Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

(back to top)

[contributors-shield]: https://img.shields.io/github/contributors/sreehari2003/Buzznet.svg?style=for-the-badge
[contributors-url]: https://github.com/graphs/contributorssreehari2003/Buzznet
[forks-shield]: https://img.shields.io/github/forks/sreehari2003/Buzznet.svg?style=for-the-badge
[forks-url]: https://github.com/network/members/sreehari2003/Buzznet/network/members
[stars-shield]: https://img.shields.io/github/stars/sreehari2003/Buzznet.svg?style=for-the-badge
[stars-url]: https://github.com/sreehari2003/Buzznet/stargazers
[issues-shield]: https://img.shields.io/github/issues/sreehari2003/Buzznet.svg?style=for-the-badge
[issues-url]: https://github.com/sreehari2003/Buzznet/issues
[license-shield]: https://img.shields.io/github/license/sreehari2003/Buzznet.svg?style=for-the-badge
[license-url]: https://github.com/sreehari2003/Buzznet/blob/main/LICENCE