/Cedula

A meta-badge system for social media

Primary LanguageTypeScriptBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Cedula

A meta-badge system for organizations on popular social media platforms



View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
    2. Usage
  2. Getting Started
  3. Roadmap
  4. Contributing
  5. License
  6. Contact
  7. Acknowledgments

About The Project

Product Name Screen Shot

Cedula is a platform that allows any organization's verified members to be represented on popular social media websites such as Facebook, Twitter, and Reddit. Users may join any listed organization using the service using the platform's website. Verified members are provided with a badge for other cedula users to see.

What do "organizations" represent? Anything! Here are some examples:

  • Legal citizens of a country
  • Licensed physicians
  • Lawyers of a bar association
  • Alumni of a university
  • Employees of a prestigious company

(back to top)

Built With

  • Next
  • React
  • Mantine
  • Fastify
  • MongoDB
  • Redis
  • Plasmo

(back to top)

Usage

Installation

  1. Download the extension straight from the webstore
  2. Signup for an account on the website

Demo

This shows the visual concept of implementing the system. As a result of this demo, you will now have all users have a default cedula badge beside their name.

  1. Click on the extension's icon to open the popup menu
  2. Click on "Preview badges on everyone"
  3. All possible links on facebook, twitter, and reddit now have cedula's logo beside their name.

Joining an Organization

  1. After logging in to the website and setting up your profile, access the organizations tab in your profile settings.
  • To access your profile settings, log in to the website, and click "My Account">"Settings"
  1. Join any organization by supplying the required documents.
  2. Once you are accepted by an assigned evaluator, the default badge of the organization will be available for everyone to see.

(back to top)

Getting Started (for developers)

Prerequisites (for developers)

Click here to show
  • npm 
    npm install npm@latest -g

Local Setup (for developers)

Click here to show
  • npm 
    npm install npm@latest -g

(back to top)

Roadmap

  • Add website source
  • Add api source
  • Add preview options
  • Published to webstore
  • Support multiple websites
    • Facebook
    • Twitter
    • Reddit
  • Modularize organizations
    • Organization creation
    • Organization admin panel
  • Modularize badges
    • Badge shop
  • Posterity
    • Monorepo
    • Documentation
    • Unit/Integration tests
    • Devops

(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 BSD 3-Clause "New" or "Revised" License. See LICENSE.txt for more information.

(back to top)

Contact

Gil Emmanuel Bancud - gembancud@gmail.com

Project Link: https://github.com/gembancud/Cedula

(back to top)

Acknowledgments

(back to top)