Thee-AIdvisors

This should be a living document! If you encounter problems or missing instructions, please add them to this document in a PR.

Table of Contents

1. About the Project
2. Local Development
3. Contributing to the Project
4. Style Guide
5. Documentation

About the Project

This repository holds the code written by the team Thee AIdvisors (Noah Lanctot, Lois Lanctot, Dhiyaa Nazim, Mason Sain, Abdul Rauoof) for Green River College's course SDEV 485 (Software Development Capstone 1) for Winter 2025.

Tech stack:

• Node.js: Backend (JS)
  • Express.js: API routes
  • nodemon: Auto restart node app
  • dotenv: Load environment variables
  • cors: Provides middleware
  • node-nlp: Provides translation from user text to responses
• React.js: Frontend (UI components, JS, HTML, CSS)
  • Vite: frontend build tool

Local Development Environment Setup

1. Clone the project repository locally. git clone https://github.com/InfiniteGmng/Thee-AIdvisors.git
2. Have the package manager npm installed (npm).
3. Create a .env file in the frontend with this variable: {VITE_FETCH_URL="http://localhost:5001/ask"}.
4. In the terminal/command line, navigate to the backend folder and install all backend dependencies with npm install.
5. Within the same backend folder, run the project with node server.js.
6. In the terminal/command line, navigate to the frontend folder and install all frontend dependencies with npm install.
7. Within the same frontend folder, run the project with npm run dev.
8. Once both the backend and frontend are running, you can access the full application by visiting the frontend URL

Contributing to the Project

1. Pull the Latest Changes
   Before starting any work, ensure your local repository is up to date with the latest changes:

git checkout main  # Switch to the main branch
git pull origin main  # Pull the latest changes

2. Create a New Branch
   Create a new branch for your changes (choose a descriptive name):

git checkout -b your-branch-name

3. Install Dependencies
   If you haven't already installed the dependencies, do so now:

npm install

4. Make Your Changes
   Make the necessary changes in the codebase.
5. Commit Your Changes
   Commit your changes with a clear, descriptive message:

git commit -m "Describe your changes here"

6. Push Your Changes
   Push your changes to the repository:

git push origin your-branch-name

7. Submit a Pull Request

• Go to the original repository on GitHub.
• Click on Pull Requests and then New Pull Request.
• Select your branch and submit the request.
• Add a description of your changes and request a review from a team member.

Contribution Guidelines

• Ensure your code follows project standards and is well-documented.
• Test your changes before submitting a pull request.
• Practice submitting pull requests and avoid committing directly to the main branch to prevent conflicts.

Style Guide

This section is to ensure consistency when adding code to the project. ** TBD BY TEAM **

Documentation

Project Structure

thee-aidvisors/
│-- backend/    # Node.js backend
│-- frontend/   # React Vite frontend
│-- README.md   # Project documentation

Code Formatting

• Documentation
• Variable naming
• Function naming

API Endpoints

(Include any relevant API endpoints here if applicable.)