AI Portfolio Analyzer

A Node.js/Express application for analyzing investment portfolios using AI.

Features

• User authentication with JWT
• Secure password hashing with bcrypt
• MongoDB database integration
• Express.js REST API
• Winston logger for application logging

Prerequisites

• Node.js 18.x or 20.x
• MongoDB database
• npm or yarn package manager

Installation

1. Clone the repository:

git clone https://github.com/AndrewDoan01/ai-portfolio-analyzer.git
cd ai-portfolio-analyzer

2. Install dependencies:

npm install

3. Set up environment variables: Create a .env file in the root directory with the following variables:

PORT=5000
MONGODB_URI=your_mongodb_connection_string
JWT_SECRET=your_jwt_secret_key

Usage

Development

Start the development server:

npm start

The server will start on http://localhost:5000 (or the PORT specified in your .env file).

Available Scripts

• npm start - Start the application
• npm test - Run tests (placeholder)
• npm run lint - Run linter (placeholder)

API Endpoints

Root

• GET / - Welcome endpoint

Authentication

• Authentication routes available at /auth

Project Structure

ai-portfolio-analyzer/
├── backend/
│   ├── app.js              # Main application file
│   ├── config/             # Configuration files
│   ├── controllers/        # Route controllers
│   ├── middleware/         # Custom middleware
│   ├── models/            # Database models
│   ├── routes/            # API routes
│   └── utils/             # Utility functions
├── .github/
│   └── workflows/         # CI/CD workflows
├── package.json
└── README.md

CI/CD

This project uses GitHub Actions for continuous integration and deployment:

• CI: Runs on every push and pull request to main and develop branches

  • Tests against Node.js 18.x and 20.x
  • Installs dependencies and runs tests
  • Verifies code syntax

• CD: Runs on push to main branch

  • Placeholder for deployment configuration
  • See .github/workflows/README.md for deployment setup instructions

Contributing

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License

This project is licensed under the ISC License.

Contact

Project Link: https://github.com/AndrewDoan01/ai-portfolio-analyzer