Fraudbuster is a backend service designed to detect and prevent fraudulent activities. This README provides an overview of the project, setup instructions, and usage guidelines.
- Real-time fraud detection
- Scalable architecture
- RESTful API
- Detailed logging and monitoring
- Node.js >= 14.x
- npm >= 6.x
- MongoDB
- Clone the repository:
git clone https://github.com/yourusername/fraudbuster-backend.git
- Navigate to the project directory:
cd fraudbuster-backend
- Install dependencies:
npm install
- Create a
.env
file in the root directory and add the following environment variables:DB_CONNECTION_STRING=mongodb://localhost:27017/fraudbuster PORT=3000 JWT_SECRET=your_jwt_secret
- Start the development server:
npm run dev
- The server will be running at
http://localhost:3000
.
POST /api/v1/login
- User loginPOST /api/v1/register
- User registrationGET /api/v1/transactions
- Get all transactionsPOST /api/v1/transactions
- Create a new transaction
Run the test suite using:
npm test
Contributions are welcome! Please read the contributing guidelines first.
This project is licensed under the MIT License. See the LICENSE file for details.
For any inquiries, please contact [email protected].