Skip to content

Readme Anjali/readme #62

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Readme Anjali/readme #62

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
73a50ff
Change in readme.md and contributing.md file
ANJALINITA Jan 9, 2025
ba80299
Update README.md and CONTRIBUTING.md with correct folder structure an…
ANJALINITA Jan 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Thank you for your interest in contributing to Social Street Smart! This documen

```
Social-Street-Smart/
├── client/ # Frontend (Chrome extension)
├── newclient/ # Frontend (Chrome extension)
├── server/ # Backend services
│ ├── clickbait/
│ ├── hate-speech/
Expand Down Expand Up @@ -47,7 +47,7 @@ Social-Street-Smart/

1. Navigate to the client directory:
```bash
cd client
cd newclient
```

2. Install dependencies:
Expand Down
16 changes: 7 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,12 @@ Social Street Smart is a Chrome extension aimed at making the internet a safer a

## Quick Start



### Frontend (Chrome Extension)

```bash
cd client
cd newclient # Change from 'client' to 'newclient'
npm install
npm run build

Expand All @@ -36,24 +38,20 @@ npm run build
cd server
docker compose up
````

## Project Structure

```
Social-Street-Smart/
├── client/ # Frontend (Chrome extension)
├── server/ # Backend services
├── newclient/ # Frontend (Chrome extension) (Updated folder name)
├── server/ # Backend services
│ ├── clickbait/
│ ├── hate-speech/
│ ├── fake-news/
│ ├── image-api/
│ └── news-origin/
├── ML/ # Machine learning models
├── ML/ # Machine learning models
│ ├── clickbait/
│ ├── hate-speech/
│ └── fake-news/
└── docker-compose.yml
```


## API Endpoints

Expand Down