Skip to content

maxscharwath/famous

Repository files navigation

FAMOUS ⚡🔍

FAMOUS is a WEB platform that allows users to find social media accounts.

It's easy to use, just enter the username and FAMOUS will do the rest. It's blazing fast ⚡

This project is largely based on the Sherlock Project. The main difference is that FAMOUS is a web platform, while Sherlock is a python CLI tool.

Development

One main goal of this project is to be able to be easily deployed on the edge ☁️.

Why? Because the edge is the best place to run this kind of project. And the result is very fast⚡!

Technologies Choice

The main technologies used are:

How to run

To run the project locally, you need to have Node.js installed.

Then, you can run the following commands:

# Install dependencies
$ yarn install

# Run the project
$ yarn dev

How to deploy

The project is automatically deployed on Vercel when a commit is pushed on the main branch. We provide two different urls, one for the staging environment and one for the production environment.

Contributing

If you want to contribute to this project, you can do it in many ways:

  • Open an issue
  • Open a pull request
  • Share the project with your friends
  • Star the project