SamMintah / chop-money-task

Chop Money Authentication System

This project implements an Authentication System using Node.js with Express as the backend and MongoDB as the database.

Getting Started

Prerequisites

• Node.js: Download and Install Node.js
• MongoDB: Install MongoDB
• Git: Download and Install Git

Installation

1. Clone the repository:

git clone https://github.com/{your-github-username}/chop-money-task.git

2. Change into the project directory:

cd chop-money-task

3. Install dependencies:

npm install

4. Set up environment variables:

Create a .env file in the project root and add the following:

MONGODB_URI=mongodb://localhost:27017/chop-money
PORT=8080
EMAIL_USER=[e-mail]
EMAIL_PASSWORD=your-email-password

Make sure to replace [e-mail] and your-email-password with your actual Gmail credentials.

Running the Application

npm run dev

The server will start at http://localhost:8080.

API Endpoints

• POST /register: Register a new user.
• POST /login: Log in and get an authentication token.
• POST /initiate-reset: Initiate the password reset process.
• POST /complete-reset: Complete the password reset process.
• GET /users: Get a list of all users (protected route).
• GET /users/:userId: Get details of a specific user (protected route).
• POST /logout: Log out .

Remember to replace {your-github-username} in the GitHub repository URL and update the content based on your specific project structure and features.