Whisper

A decentralized networking platform
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

This is a project based on the NEAR Blockchain. It is a decentralized networking platform, where people with similar interests can gather in communities to share ideas, thoughts and aspirations. People can join communities, read and vote on posts and even create their own communities. Try it for yourself!

(back to top)

Built With

• AssemblyScript
• React.js

(back to top)

The Intent

All of today's popular social media apps are centralized, and control all of their users' data. For doing absolutely anything on these apps, users have to share their emails, contact and even addresses in some cases. The intent of this project is to create an application that serves all the essential features of a social media app, but also helps you retain your privacy. With just one's NEAR account, one can become a user in this app, read and make posts, vote on posts, and create communities. It is also a way by which people can easily pay content-posters money, as tokens of appreciation. It is a project that intends to help people fearlessly bring their opinios to the forefront.

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/Kapil-Mulay-1421/Whisper.git

2. Have nodemon installed

   npm install nodemon

3. In the main directory, run

   npm run dev

(back to top)

Usage

1. Head over to localhost:1234.
2. Start by creating a community. On the nav bar, click Create a Community.
3. Enter a name and a description for your community, and submit.
4. Back on the home page, spot your community, which will take you to the community page.
5. Here, users can gather, chat, and post their ideas and thoughts. Try posting something.
6. You can also upvote posts. Users have the option to attach a little money alongside the upvote, which goes directly to the creator of that post.

• You can do all this, and still retain your privacy on this decentralized networking platform.

Unit Tests

• In the main directory, enter:

  npm run test

Build

• In the main directory, enter:

  npm run build

(back to top)

Roadmap

• Create a basic posts app.
• Extend the functionality to a full multi-community networking platform.

See the open issues for a full list of proposed features (and known issues).

(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)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Kapil Mulay - krmulay@gmail.com

Project Link: https://github.com/Kapil-Mulay-1421/Whisper

(back to top)

Acknowledgments

• The NEAR Foundation
• NEAR University
• NEAR Academy

(back to top)