Rockwell

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #typescript #machine-learning #deep-learning #docker #macos #windows #awesome #security #openai #open-source

(★ 9)

Rockwell uses the twitter authentication workflow to render a twitter like feed in order to collect information about the users interaction with their feed. It also has an attention check feature to ensure that the user is being observant of their feeds and not simply scrolling through with the intent of finishing quickly.

Rockwell Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Rockwell

Rockwell uses the twitter authentication workflow to render a twitter like feed in order to collect information about the users interaction with their feed. It also has an attention check feature to ensure that the user is being observant of their feeds and not simply scrolling through with the intent of finishing quickly.

# Tech Stack

Rockwell uses a postgresql database, a python backend, and a Node/React.Js frontend.

# Installation
Navigate to the backend folder and run:
```
pip install -e .
```

Navigate to the frontend folder and run:
```
npm i
```

Use the bash script in the backend to run the backend servers (requires tmux) and run npm start
to spin up the front end.

The config files in both the front and backend must also be filled out and the database
tables in the DatabaseScript must be placed on a postgresql database.

# Deployment Steps
1. SSH into the your server where the app is located (or where you intend to clone it) (we assume Ubuntu):

2. Ensure that you have pip, nginx and npm installed:
  ```
  sudo apt-get update
  sudo apt install python3-pip
  sudo apt-get install nginx
  sudo apt install npm
  ```
  
3. Clone the repository into your server if you have not already done so, using: 
  ```
  git clone https://github.com/CSDL-USF/Rockwell.git
  ```
  
4. Ensure that your directory has read and write permissions:
  ```
  sudo chmod 777 Rockwell 
  cd Rockwell
  ```
  
The following steps are used to host the front-end:
1. cd into the frontend portion of the app:
  ```
  cd frontend
  ```

2. Install npm files, and build:
  ```
  sudo npm install
  sudo npm run build
  ```
  
3. Create the pem files to allow for ssl_certificates (for https encryption):
  ```
  cd ~
  openssl req -x509 -newkey rsa:4096 -nodes -out cert.pem -keyout key.pem -days 365
  ```
4. Answer the questions that are asked after running the above command.

5. We will now configure nginx:
  ```
  sudo rm /etc/nginx/sites-enabled/default
  sudo vi /etc/nginx/sites-available/Rockwell.nginx
  ```
4. Please refer to this [nginx file](/scripts/Deployment/sample.nginx) for the contents of the nginx file. It contains the ability to enable https encryption.

5.Link the sites-available and sites-enabled config files
  ```
  sudo ln -s /etc/nginx/sites-available/Rockwell.nginx /etc/nginx/sites-enabled/Rockwell.nginx
  ```
  
6. Now start the nginx server:
  ```
  sudo systemctl reload nginx
  ```

7. Important note, you must rebuild the app and reload nginx whenever the frontend is modified
  
The following steps are used to host the back-end:
1. cd into the backend portion of the project
  ```
  cd Rockwell/backend
  ```

2. Create the pythonn virtual environment and install the python packages:
  ```
  sudo apt install python3-venv
  python3 -m venv .venv
  source .venv/bin/activate
  pip install -e .
  deactivate
  cd ~
  ```
  
3. We will now configure the gunicorn servers for all apps, starting with twauth-web
  ```
  sudo vi /etc/systemd/system/twauth-web.service
  ```

4. Please refer to the [service file](scripts/Deployment/twauth-web.service) for this service file's contents

5. Repeat steps 3 and 4, but now for [twitterFeedGeneration.service](scripts/Deployment/twitterFeedGeneration.service), [Retweet.service](scripts/Deployment/Retweet.service), and [database_access.service](scripts/Deployment/database_access.service)

6. Now start the gunicorn servers for these apps:
  ```
  sudo systemctl daemon-reload
  sudo systemctl start twauth-web
  sudo systemctl start twitterFeedGeneration
  sudo systemctl start Retweet
  sudo systemctl start database_access
  ```
 
7. In order to check the statuses of these apps:
  ```
  sudo systemctl status twauth-web
  sudo systemctl status twitterFeedGeneration
  sudo systemctl status Retweet
  sudo systemctl status database_access
  ```
8. Important note: You must restart the services whenever the backend app is modified

The following information describes the use of tmux in order to run the eligibility app:
1. cd into the eligibility folder (assuming you are in the home directory):
  ```
  cd Rockwell/backend/src/eligibility
  ```

2. Run npm install to obtain all necessary dependencies
  ```
  sudo npm install
  ```
  
3. Install tmux:
  ```
  sudo apt-get update
  sudo apt-get install tmux
  ```
  
 4. Start a tmux session, titled eligibility for appropriate naming convention:
   ```
   tmux new -S eligibility
   ```
 5. Now run the eligiblity app:
  ```
  sudo npm start
  ```
  
 This last part of the tutorial is about enabling https encryption:

1. Previously we have already set up the pem files and the nginx file to allow for https encryption. We will now use certbot to allow for proper encryption:
  ```
  sudo snap -install --classic certbot
  ```
2. Now create a symbolic link:
  ```
  sudo ln -s /snap/bin/certbot /usr/bin/certbot
  ```
3. Now load the configuration to your nginx file:
  ```
  sudo certbot --nginx -d (your_domain) -d (your_domain)
  ```
4. You may be asked if you would like to redirect http accesses to https. If so, say yes

Rockwell

Rockwell Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Rockwell

Rockwell Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README