Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create tutorial for local deployment #204

Open
glciampaglia opened this issue Aug 1, 2023 · 1 comment
Open

Create tutorial for local deployment #204

glciampaglia opened this issue Aug 1, 2023 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@glciampaglia
Copy link
Collaborator

glciampaglia commented Aug 1, 2023

So far we have deployed Rockwell on our own server, and it is difficult to fix bugs on this deployment, since it is the same used for running the experiment. Therefore, we would like create a local deployment so that every developer can run a development instance of Rockwell on their laptop.

One problem is that for the instance to be useful, it should display some tweets. However, because tweet collection is now capped, it is critical that we do not collect new tweets inside development instances.

To solve this issue, we can use a commodity Twitter account, whose credentials need to be stored in a secure location (not in the Rockwell repo, which is public), and collect home timeline tweets for this account once. Then, these tweets can be loaded into the database so that a local deployment of Rockwell can display tweets as if they had been collected automatically.

The first task is to write down a step-by-step tutorial describing all the steps needed to deploy Rockwell. There is already a tutorial written in the main README of Rockwell, however that tutorial is meant for deployment of a production instance (using SSL certificates) in an ubuntu machine on AWS. So some of the steps may not make sense for a local deployment (where we cannot create SSL certificates).

The first task is to review the instructions in the README and identify the steps that need to be changed. We also need to update any old information (including links to files in the repo), and "test" that these instructions are self-contained (meaning they can be followed without need for additional research by the user).

@glciampaglia glciampaglia added the documentation Improvements or additions to documentation label Aug 1, 2023
@glciampaglia
Copy link
Collaborator Author

We have a draft of the tutorial from Scott, @saumyabhadani95 needs to add instructions for how to load into the DB the set of data for testing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants