Skip to content

Latest commit

 

History

History
92 lines (59 loc) · 2 KB

README.md

File metadata and controls

92 lines (59 loc) · 2 KB
Raw

CSE210-Recommender-Project

CSE-210 Project

Table of Contents

  1. Prerequisites
  2. Getting Started
  3. Additional Setup
  4. Detailed Documentation

Prerequisites

Make sure you have the following installed on your machine:

Getting Started

  1. Clone the repository:

    git clone https://github.com/XSiling/CSE210-Project.git

  2. Navigate to the project folder:

    cd CSE210-Project

  3. Install Dependencies:

    Run the following command to install the project dependencies.

    npm install

  4. Start the Server:

    Launch the servers using the following commands in different terminal instances.

    npm run server1
    npm run server2

    The servers will start running.

  5. Launch the Website:

    Open the project in Visual Studio Code and use the Live Server extension to launch the website.

    • Install the Live Server extension if you haven't already.
    • Right-click on the /src/login.html file and select "Open with Live Server."

    This will open the website in a new browser window/tab.

Additional Setup

For the recommendation system, you need to install the following:

pip3 install Mastodon.py
pip install flask
pip install flask-cors
python -m pip install mysql-connector-python

Set environment variables

Create an env.py file as follows:

import os
os.environ['Mastodon_username'] = 'Your mastodon email'
os.environ['Mastodon_password'] = 'Your mastodon password'

Documentation References

For more details on implementational functionality and tests, refer to individual function and API pages.