diff --git a/README.md b/README.md new file mode 100644 index 0000000..d63480d --- /dev/null +++ b/README.md @@ -0,0 +1,42 @@ +# Twitter Hashtags Counter +A simple Angular 2 project that let you search for an hashtag on Twitter and count who and how many times used that hashtag + + +## Demo +Here's a [demo](https://twitterhashtagscounter.azurewebsites.net/) version of this application + + +## Deployment +You can download a pre-built version and follow the [Server-side setup](#server-side-setup) and deploy the package to your server. + +Alternately you can build on your own following this [guide](Building). + + +## Get the source code + - Create a folder + - Enter that folder + - Open a command prompt/bash + - Run git clone https://github.com/l0ll098/TwitterHashtagsCounter.git. This will clone this repo in your folder (you need [Git](https://git-scm.com/downloads)) + + +## Server-side setup + - Open the folder where you have downloaded the source code + - Rename the file config.template.js to config.js + - Open that file and replace the placeholder value with the keys generated by Twitter. You can find them in the [Application Management page](https://apps.twitter.com/) -> Navigate to your app (create a new one if don't already have one) -> Open the *"Keys and Access Tokens"* section + - Save the file + + +## Building + + ### Server-side + - [Get the source code](#get-the-source-code) + - [Server-side setup](#server-side-setup) + - Run npm install in the root directory + + + ### Client-side + - [Get the source code](#get-the-source-code) + - Enter the client folder and + - Run npm install + - Run ng build --prod --aot to build the Angular 2 app + - Run npm run precache to generate an upadated version of service-worker.js