Scam Alert :rotating_light:

Overview :mag_right:

Scam Alert is an open-source platform where users can share and alert others about new types of scams. The goal is to create a community-driven space to identify and report various scam attempts, helping to protect people from fraud.

Features :sparkles:

Users can post information about new scams
Ability to categorize scams (phishing, investment fraud, tech support, etc.)
Community upvote and comment system for scam alerts
Search and filter functionality to find specific scams
Admin dashboard for moderating posts.

Installation :wrench:

Clone the repo:

git clone https://github.com/Lets-code-with-us/scam-alert.git

Navigate to the project directory:
```
cd scam-alert
```
Install dependencies:
```
npm install
```
Add the env variables

Name	Description	Required?
`MONGO_URL`	The Mongo DB connection string to connect to the DB.	✔️
`SECERT_KEY`	The JWT Secret Key	✔️
`NEXT_PUBLIC_CLOUDINARY_CLOUD_NAME!`	The Cloudinary Cloud Name(For Uploads)	✔️

Run the development server
```
npm run dev
```
For the database, use MongoDB Atlas or a Docker Image :
```
docker pull mongodb
```

Available Scripts 📜:

npm run dev: Runs the app in development mode with Turbo.
npm run build: Builds the app for production.
npm start: Starts the production server.
npm run lint: Runs the linter to check for code style issues.
npm run format: Formats the code using Prettier.
npm run check: Checks if the code is formatted correctly.
npm run build:turbo: Runs type checking and builds the app using Turbo.
npm run build:check: Runs type checking and builds the app.
npm run prepare: Sets up Husky for Git hooks.
npm test: Runs the test suite.
npm run test:watch: Runs the test suite in watch mode.

Run any of these scripts in your terminal

npm run <script-name>

Tech Stack :computer:

Contributing :handshake:

We welcome contributions to the project! Here are the steps to get started with contributing to the project :

Fork the repository: Click the "Fork" button at the top right of this page to create a copy of the repository in your GitHub account.
Clone the repository: Clone your forked repository to your local machine using the following command:
```
git clone https://github.com/your-username/scam-alert.git
```
Create a new branch: Create a new branch for your feature or bugfix:
```
git checkout -b feature-name
```
Install dependencies: Navigate to the project directory and install the dependencies:
```
cd scam-alert
npm install
```
Make your changes: Implement your feature or bugfix.
Run tests: Ensure all tests pass before committing your changes. You can run tests using:
```
npm test
```
Commit your changes: Commit your changes with a descriptive commit message:
```
git commit -m "Description of your changes"
```
Push to your fork: Push your changes to your forked repository:
```
git push origin feature-name
```
Create a Pull Request: Open a Pull Request to the main repository. Provide a clear description of your changes and any related issue numbers.
Review and address feedback: A maintainer will review your Pull Request and suggest any changes. Be sure to address any feedback before your Pull Request can be merged.

Join Us :raised_hands:

👀 Our Contributors

We extend our heartfelt gratitude for your invaluable contribution to our project! Your efforts play a pivotal role in elevating ScamWebsiteV1 to greater heights.
Make sure you show some love by giving ⭐ to our repository.

Happy Coding 💻 and we look forward to your contributions during Hacktoberfest 2024! 🎃

Lets-code-with-us / scamwebsiteV1

readme