Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ sentiment-analysis-api/
├── .env # Environment variables
├── pytest.ini # Pytest configuration
├── README.md # Project documentation
├── CONTRIBUTING.md.md # Project documentation
├── CONTRIBUTING.md # Project documentation
├── requirements.txt # Lists required Python dependencies
├── run.py # Entry point to run the app
├── samples/ # Sample input files for testing
Expand Down Expand Up @@ -108,7 +108,7 @@ This structure helps separate the application logic, configuration files, test f
```bash
python -m venv env
```
4. **Activate the virtual environment**
3. **Activate the virtual environment**
- **Linux**
```bash
~/sentiment-analysis-api$ source env/bin/activate
Expand All @@ -117,24 +117,24 @@ This structure helps separate the application logic, configuration files, test f
```bash
env\Scripts\activate
```
6. **Install pip Dependencies**
4. **Install pip Dependencies**
```bash
(env) ~/sentiment-analysis-api$ pip install -r requirements.txt
```
7. **Install <a href="https://www.ffmpeg.org/" target="_blank">FFmpeg</a>**
5. **Install <a href="https://www.ffmpeg.org/" target="_blank">FFmpeg</a>**
- **Linux**
```bash
~$ apt-get -y update && apt-get -y upgrade && apt-get install -y --no-install-recommends ffmpeg
```
- **Windows (Win10)**
- Follow Tutorial [here](htps://www.youtube.com/watch?v=IECI72XEox0)
- Follow Tutorial [here](https://www.youtube.com/watch?v=IECI72XEox0)
- Add FFmpeg to the system path.
8. **Run Flask App**
6. **Run Flask App**
- In Debug Mode [port 8001]
```bash
~/sentiment-analysis-api$ python3 -m run
```
9. **Run API Documentation**
7. **Run API Documentation**
- Access the API documentation at: http://localhost:8001/apidocs

<!-- Docker -->
Expand All @@ -153,7 +153,7 @@ This structure helps separate the application logic, configuration files, test f
```bash
~/sentiment-analysis-api$ docker build -t sentiment_analysis_api .
```
6. **Start Docker Conatiner (Port 8001)**
4. **Start Docker Container (Port 8001)**
- **New Container**
```bash
~/sentiment-analysis-api$ docker run -d --name sentiment_analysis_api_app -p 8001:8001 -v ./:/sentiment-analysis-api sentiment_analysis_api
Expand All @@ -162,7 +162,7 @@ This structure helps separate the application logic, configuration files, test f
```bash
~/sentiment-analysis-api$ docker start --name sentiment_analysis_api_app
```
7. **Run API Documentation**
5. **Run API Documentation**
- Access the API documentation at: http://localhost:8001/apidocs


Expand Down Expand Up @@ -264,10 +264,10 @@ This repository is part of the [Google Summer of Code (GSoC) 2024](https://summe
- GSoC'24 Project Page: [Sentiment Analysis API Project GSoC 24 Program](https://summerofcode.withgoogle.com/programs/2024/projects/V469U9cf)
- Progress Tracking Docs: [GSOC'24 Project Progress and Follow Up Sheet](https://docs.google.com/spreadsheets/d/1wnTACVlsw_JWCWV70Log1DFwilxwmj_azB3TekGA3OY/edit?usp=sharing)
- Meetings Presentations: [Slides](https://drive.google.com/drive/u/1/folders/1SMujWE0p7Xz_CaS0e9qKkLRcDt7YX729)
- Main Reposotory for the Project: [sentiment-analysis-api Repo](https://github.com/ruxailab/sentiment-analysis-api)
- Main Repository for the Project: [sentiment-analysis-api Repo](https://github.com/ruxailab/sentiment-analysis-api)
- Integration to [RUXAILAB](https://github.com/ruxailab/RUXAILAB) PR Requests<a id="integration_to_ruxailab"></a>:
- [PR #533](https://github.com/ruxailab/RUXAILAB/pull/533)
- Wikkis:
- Wikis:
- [Deployment Study Guide](https://github.com/ruxailab/sentiment-analysis-api/wiki/Deployment-Study-Guide)
- [Speech2Text Tools Survey](https://github.com/ruxailab/sentiment-analysis-api/wiki/Speech2Text-Tools-Survey)
- [VueJs and Vuetify Study Guide (RUXAILAB Repo)](https://github.com/ruxailab/RUXAILAB/wiki/VueJs-and-Vuetify-Study-Guide)
Expand Down