Git Product home page Git Product logo

eddiehubcommunity / biodrop Goto Github PK

View Code? Open in Web Editor NEW
5.7K 51.0 4.0K 42.18 MB

Connect to your audience with a single link. Showcase the content you create and your projects in one place. Make it easier for people to find, follow and subscribe.

Home Page: https://biodrop.io

License: MIT License

JavaScript 81.28% CSS 0.83% Dockerfile 0.05% MDX 17.84%
reactjs javascript nextjs css hacktoberfest html nodejs tailwind docker mongodb

biodrop's Introduction

RepoRater Open in Gitpod Uptime GitHub release (latest by date) GitHub repo size

Project renamed from LinkFree to BioDrop(please update your local git clones with the new remote name)

BioDrop logo on a sticker

What is BioDrop?

A platform where people in tech can have a single hub to showcase their content in order to accelerate their career, whilst contributing to an Open Source project and being part of a community that has a say in where the project is going.

Your profile will have links to your social media and content. You can also add your timeline, testimonials, and upcoming events that you are participating in.

Here is an example of a BioDrop Profile https://biodrop.io/eddiejaoude

Example profile and statistics page on BioDrop with light and dark mode

Hacktoberfest

Important

Creating/Changing/Deleting your JSON Profile do not count towards hacktoberfest and will automatically be marked with the label invalid so that Hacktoberfest ignores your Pull Request But this does not affect your Pull Request being accepted and merged into BioDrop

All other Pull Requests will count towards Hacktoberfest.

If you are a new contributor to this project, have a look out for issues that have the Hacktoberfest label.

Tech Stack

BioDrop is built using the following technologies:

  • Next.js - a framework for building server-rendered React applications
  • MongoDB - a NoSQL database
  • Tailwind CSS - a utility-first CSS framework

Quickstart

You have 4 options to contribute to the repo, please pick your favourite from:

  1. GitHub UI (recommended for adding/editing your profile)
  2. Gitpod
  3. Local development
  4. Local development with Docker Compose

Brief documentation is below, but full documentation can be found here https://biodrop.io/docs

Warning: Your DB will be empty, you will need to load the data into the database! You can do this by visiting the url /api/system/reload?secret=development

GitHub UI

This is great if you only want to add your Profile or make changes to it.

Here is the QuickStart guide to add your profile

Note: give extra attention to JSON formatting and the GitHub Action after you create the Pull Request

Read more in the official documentation - https://biodrop.io/docs/environments/github-ui

Gitpod

In the cloud-free development environment which will have all the dependencies you need (for example MongoDB).

Open BioDrop in Gitpod

Read more in the official documentation - https://biodrop.io/docs/environments/gitpod

Local development

This environment is fully on your computer and requires each dependency (for example MongoDB) to be installed and set up, but it gives you the most flexibility for customisation.

Prerequisites

Before contributing or adding a new feature, please make sure you have already installed the following tools:

  • NodeJs (Works with Node LTS version v18.16.1)
  • MongoDB (v6+)
  • Optional NVM: Switch Node version by using nvm use (on Windows, use nvm use v18.16.1). If this is not installed, run nvm install v18.16.1.

Commands

You can set this up locally with the following steps:

  1. copy the .env.example file to .env and update any details required
  2. MongoDB is required, it is possible to use docker compose up to start the MongoDB service
  3. npm ci
  4. npm run dev

Read more in the official documentation https://biodrop.io/docs/environments/local-development#local-development

Local development with Docker Compose

This will allow you to run your favourite IDE but not have to install any dependencies on your computer like NodeJS and MongoDB.

Prerequisites

Commands

  1. git clone https://github.com/EddieHubCommunity/BioDrop

  2. cd BioDrop

  3. docker compose up

  4. In your browser on localhost:3000 you should now see the project up and running.

  5. Now you need to upload the data in your mongoDB instance. localhost:3000/api/system/reload?secret=development

  6. Recheck localhost:3000 to confirm data is uploaded, you should see current amount of active users.

Note If you wanna look at the database, you can use MongoDB Compass with connection string as mongodb://localhost:27017/biodrop

Read more in the official documentation - https://biodrop.io/docs/environments/local-development#docker-compose

How to add YOUR Profile

Step by step quickstart guide can be found in the full docs here

Testimonials

Here are some testimonials from individuals who have used BioDrop:-

Francesco Ciulla

Francesco Ciulla

"I had another similar (paid) service. I tried BioDrop for a week and I got almost double the clicks on the links in the same period, redirecting from the same link. I decided to start using it regularly. I am very satisfied. It's not just a list of links but it's backed by a great Open Source community."

  • Name : Francesco Ciulla
  • Bio : Developer Advocate at daily.dev, Docker Captain, Public Speaker, Community Builder
  • Username : Francesco Ciulla

Amanda Martin

Amanda Martin

"Where BioDrop really stands out is the ability to make meaningful connections and find collaborators due to thoughtful features that are not simply about chasing ways to build your audience. The fact that it's also Open Source really makes it the tool I was waiting for in this space."

  • Name : Amanda Martin
  • Bio : Developer Advocate | Always Curious | Always Silly
  • Username : Amanda Martin

Pradumna Saraf

Pradumna Saraf

"BioDrop is very close to me because I have seen it evolve. With BioDrop, I have discovered so many amazing people in tech. Some of my favorite features are the barcode for profiles and testimonials. If you are reading this and don't have a profile, I highly recommend doing that. Thank you, Eddie and EddieHub community, for building this incredible app."

  • Name : Pradumna Saraf
  • Bio : Developer Advocate ๐Ÿฅ‘ | DevOps | Golang Developer | EddieHub Ambassador
  • Username : Pradumna Saraf

GitHub Accelerator

BioDrop was accepted into the GitHub Accelerator program... GitHub Accelerator https://accelerator.github.com

Support

Don't forget to leave a star โญ๏ธ.

Our Pledge

We take participation in our community as a harassment-free experience for everyone and we pledge to act in ways to contribute to an open, welcoming, diverse and inclusive community.

If you have experienced or been made aware of unacceptable behaviour, please remember that you can report this. Read our Code of Conduct for more details.

biodrop's People

Contributors

amandamartin-dev avatar ayebakurooruwori avatar badrivlog avatar bsatishsutar avatar cahllagerfeld avatar cbid2 avatar chinmaymhatre avatar dan-mba avatar eddiejaoude avatar github-actions[bot] avatar grand-rick001 avatar harshdeep61034 avatar ibilalkayy avatar imkrishnasarathi avatar kendalldoescoding avatar kirtankp avatar kumarsonsoff3 avatar loftwah avatar money8203 avatar panquesito7 avatar pradumnasaraf avatar priyankarpal avatar sandippalit avatar sarajaoude avatar schmelto avatar shubhxg avatar sital002 avatar tobysolutions avatar viveksati5143 avatar xkrishguptaa avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

biodrop's Issues

Convert to Angular

๐Ÿ’œ ๐Ÿ’œ ๐Ÿ’œ ๐Ÿ’œ ๐Ÿ’œ ๐Ÿ’œ ๐Ÿ’œ ๐Ÿ’œ ๐Ÿ’œ ๐Ÿ’œ

Add License

The current project does not have a license. So I suggest MIT standard license as of now

Load data/*.json file from domain name or from the URL

To support routes:

thisproject.com/stemount would load stemount.json

but if you use this project for your own domain, you could load in this order:

json/{{ url_slug }} (support being able to use something.com/url_slug)
json/{{ domain }} (if no URL slug, look at URL domain e.g. something.com.json)
json/me.json (a default in general)

Socials

Can i add more socials? Like telegram, youtube, instagram etc.

Deploy project

Update: ingress config is not loading, there is no service running, could this be the issue?

Deployed to Kubernetes

Screenshot 2021-09-11 at 08 49 10

DNS looks ok

works: api.eddiehub.org

dig api.eddiehub.org

; <<>> DiG 9.10.6 <<>> api.eddiehub.org
;; global options: +cmd
;; Got answer:
;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 24845
;; flags: qr rd ra; QUERY: 1, ANSWER: 1, AUTHORITY: 0, ADDITIONAL: 0

;; QUESTION SECTION:
;api.eddiehub.org.		IN	A

;; ANSWER SECTION:
api.eddiehub.org.	2563	IN	A	67.207.70.148

;; Query time: 67 msec
;; SERVER: 10.0.1.1#53(10.0.1.1)
;; WHEN: Sat Sep 11 08:52:35 BST 2021
;; MSG SIZE  rcvd: 50

fails: linkfree.eddiehub.org

dig linkfree.eddiehub.org

; <<>> DiG 9.10.6 <<>> linkfree.eddiehub.org
;; global options: +cmd
;; Got answer:
;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 8309
;; flags: qr rd ra; QUERY: 1, ANSWER: 1, AUTHORITY: 0, ADDITIONAL: 0

;; QUESTION SECTION:
;linkfree.eddiehub.org.		IN	A

;; ANSWER SECTION:
linkfree.eddiehub.org.	472	IN	A	67.207.70.148

;; Query time: 61 msec
;; SERVER: 10.0.1.1#53(10.0.1.1)
;; WHEN: Sat Sep 11 08:52:46 BST 2021
;; MSG SIZE  rcvd: 55

Kubernetes config

API (works) https://github.com/EddieHubCommunity/api/tree/main/kubernetes
LinkFree (fails) https://github.com/EddieHubCommunity/LinkFree/tree/main/kubernetes

Spelling mistake in README.md

After Add your Profile to the home page
Currently it says : Update the file public/data/_list.json with the following object to thje collection:
Need to be fixed as : Update the file public/data/_list.json with the following object to the collection:

Telegram

Please create a group on telegram ( instant messaging application ).

GitHub action for linting the data/*.json files

We need to catch in the pull request GitHub action that the file doesn't have a trailing comma, or the JSON file is malformed.

This would stop the necessity for someone to reply to a pull request, it would prevent a merge!

Adding Contributing Guidelines

We should add a CONTRIBUTING.md file to the root folder of the repository.

This file should include:

  • Steps to set up a local instance of the project
  • Instructions to add the JSON file
    • Include an example of formatting (emphasise github.com/<username>.png for avatars)
  • Requirements for submitting a PR
    • Conventional commit messages

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.