Tutorial Video
Description of Application
The cReddit Hours project is a web-based application that provides users the overall sentiment analysis of the UNC subreddit community based on the sentiment analysis per post.
How to Use
To use this application, the client must have Python 3.9 installed and ready to use.
Go to the repository: https://github.com/COMP523-Team-O/demo and click the green “Code” button (where you can clone the repository), and copy the HTTPS link to use for when cloning. Open a new terminal, go to your directory where you wish to clone the repository and run the command:
git clone https://github.com/COMP523-Team-O/demo.git
After doing so, you should see the code appear in your IDE environment. Once accessed, open another terminal and make sure you are in the backend directory of the application (for example, if you are in the demo directory, you can go into the backend directory by running this command: cd backend).
After going to the backend directory, you will need to run a virtual environment to install all of the dependencies. To do this, you can run the command:
python -m venv venv
inside of the same terminal. To activate this environment, you can run:
source venv/bin/activate
or
venv/Scripts/activate
Once inside of your virtual environment, run the following command within the same terminal to install all of the dependencies:
pip install fastapi uvicorn praw nltk
After installing all of the dependencies, run the following command to open the backend server:
uvicorn main:app - - reload
After this runs, open up a new terminal within the application directory, and go to the subreddit-app directory:
cd subreddit-app
Once you are in this directory, run:
npm install
to install all of the packages for the frontend, and then to start the application run:
npm start
This will all be listed in the ReadMe file in the GitHub repository
Access to Database
If you would like access to the Firebase database, please email arogyadhakal@gmail.com