The these three features are proposed by us.
- Databind : a lookup tool that uses OSINT to get user data on different parameters like username, email, name. etc
- Detectron : a detection tool that will fetch data from news url and give a detailed overview of it with summary, visulaization, analysis, detect propoganda, hate speech, etc.
- Demystify : To analyse the patterns/trends of social media and classify them according to some predefined fields like - most active, most used, hate speech,etc. To understand the social activity and decode the patterns behind them. Also, the individual can be identified with the most hate speech used related to any topic.
Technology stack: We will be using flask for the backend and next.js for the frontend.
Read our workflow guide, and have a look at issues marked with the Hacktoberfest
tag on it. Do not forget to read the rest of the README. For serious doubts, contact the project maintainers on our discord server.
All the dependencies used in this project will be listed in the package.json
file and requirements.txt
file.
Configure the project with all dependencies
Fork and clone the repo
git clone <your-forked-repo-url>
cd Cybode
Now go ahead and setup the frontend
Make sure you have npm or yarn installed in your system if not pls do that
With npm
cd www.cybode.com
npm install
npm run dev
With yarn
cd www.cybode.com
yarn install
yarn dev
Now setup your backend server
It is suggested to create a virtualenv
cd api.cybode.com
pip install virtualenv
virtualenv venv
Activate the venv
On windows
venv\Scripts\activate
On linux
source <path-to-venv>
Now install the dependencies
pip install - r requirements.txt
To start working on this project first you need to create .env
file. This .env file will contain:
Huggingface API key
which you will get by creating an account on huggingface
HUGGINGFACE_API=hf_your_key
Tada project is up and running!
-
Choose an issue, bug, exploit, or feature to work on: Start by identifying an issue or feature in the repository that you would like to work on. If you can't find an existing issue or feature, you can create a new one.
-
Fork the repository: Once you have identified an issue or feature to work on, you will need to fork the repository. This creates a copy of the repository in your own GitHub account.
-
Clone the repository: Next, you will need to clone the repository to your local machine. You can do this by using the git clone command and specifying the URL of the repository.
-
Create a new branch: Before making any changes, you should create a new branch in your local repository. This will keep your changes separate from the main branch of the repository and make it easier to submit a pull request later on.
-
Make your changes: Now you can make your changes to the code in your local branch. Be sure to follow the project's coding style and conventions.
-
Test your changes: Once you have made your changes, be sure to test them thoroughly to ensure that they work as intended and do not introduce new issues or bugs.
-
Commit your changes: Once you are satisfied with your changes, commit them to your local branch using the git commit command.
-
Push your changes: Once you have committed your changes, push them to your forked repository on GitHub using the git push command.
-
Open a pull request: Finally, open a pull request to merge your changes into the staging branch of the repository. Be sure to describe your changes and explain why they are necessary or beneficial. Note that the project maintainers may request changes or reject your pull request, so your first pull request is not guaranteed to be accepted.
It's also worth noting that you should communicate with the project maintainers and other contributors to ensure that your changes align with the project's goals and direction.