Skip to content

Latest commit

 

History

History
113 lines (72 loc) · 1.72 KB

README.md

File metadata and controls

113 lines (72 loc) · 1.72 KB

Loop 🔄

Discover events, societies and more at your university.

Setup

Make sure you have the following prerequisites installed on your system:

  1. NodeJS (v18.7.0 or above)
  2. NPM (v9.0.0 or above)
  3. Python (v3.9 or above)

Clone the repository to a desired location on your system:

git clone https://github.com/Caramel-Labs/loop.git

Navigate into the cloned directory:

cd loop

The Frontend

To setup the Loop frontend, navigate to the client folder from the root folder:

cd client

Install the required packages:

npm install

Launch a development server:

npm run dev

The Backend

To setup the Loop backend, navigate to the api folder from the root folder:

cd api

Install the required packages:

npm install

Launch a development server:

node index.js

The Chatbot

To setup the Loop chatbot, navigate to the chatbot folder from the root folder:

cd chatbot

Install the required packages:

pip install -r requirements.txt

Launch the chatbot API service:

python main.py

The Chatbot

To setup the Loop recommendation engine, navigate to the recommender folder from the root folder:

cd recommender

Install the required packages:

pip install -r requirements.txt

Launch the recommender API service:

python main.py

After the above steps have been completed, open up localhost:3000 in the browser to view the Loop app.

It is recommended to open Loop in a 360 x 800 screen size.


This project is licensed under the Apache License.