From e1f8a53ca74156dc58314f31653656981305c505 Mon Sep 17 00:00:00 2001 From: Jonathan Kerr Date: Wed, 14 Apr 2021 18:55:05 +0100 Subject: [PATCH] WIP - Writing guide to installation and deployment --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index a5203d5..4cda7c3 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,24 @@ # twitter-list-follower This is a little service to enable users to follow everyone in a list. Because of Twitter's API rate limits, a user's request to follow an entire list is queued up behind everyone else using the service. Consequently it might be several days before you see all the new people you're following. + +## What you'll need + +- you'll need credentials for a Twitter app. Your users will be asked to authorise you, and you'll need quite significant permissions. You can get those by [following the instructions on the developer pages of Twitter.](https://developer.twitter.com/en/docs/getting-started). Those credentials go in [runtime/.chalice/config.json](./runtime/.chalice/config.json) +- you'll need [an AWS account, with some billing set up](https://aws.amazon.com/premiumsupport/knowledge-center/create-and-activate-aws-account/). Depending on how may users you have, this app could cost you a fortune - or it could cost you absolutely nothing. Lambda is complicated. I'm going to work on ways to call some of these asynchronously, rather than spamming queues, which is what it does at the moment. +- you'll need credentials for AWS stored locally. Check out the section of [this guide entitled 'Programmatic Access'](https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html) + +## How to deploy + +You'll need to use the terminal. All of these instruction assume you're in the root directory (cdk-list-follower), which means if you type `ls` you should see this: +``` +infrastructure LICENSE README.md requirements.txt runtime +``` +The first thing we're going to do is create a virtual environment to run our python code in: +`$ python3 -m venv venv` + +your computer will think about it for a while. + + + +From the root folder - cdk-list-follower - type `cdk deploy` into your terminal