An application for tracking social media statstics and follower sentiment.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them:

• ASP.NET Core 2.1
• angular cli
• Node.js

Running App Locally

To run a local version of the project:

cd ClientApp
npm install
npm start

Then visit localhost:4200 to view and interact with the application.

Adding new npm packages

cd ClientApp
npm install --save <package_name>

Running ng commands

Used when generating new components, modules, etc.

cd ClientApp
ng <command-name>

Running the tests

Run ng test from root to run front-end tests.

Deployment

TBD

We could probably use this guide for deploying and hosting this sort of application. And/or maybe this one for publishing to Azure?

The process might be something like:

1. Run dotnet publish to compile app code and copy the files required to run the app to the dist or publish folder.
2. Set up an appropriate process manager on the VM (I think we have Nginx right now, but we might need to switch to IIS or Windows Service)
3. Copy the output of dotnet publish to the VM/server.

We might want to automate our deployments, so that we don't need to assign a single person to it. IMO it'd be ideal if we deployed every time our master branch was updated. We might be able to use Travis CI for this...? Or maybe Azure? Somehow.

Built With

• .NET Core - backend framework
• Angular - frontend framework
• Bootstrap 3 - css framework

More should be added here later.

Authors

• Manuel Fernandez
• Vladimir Rozin
• Julia McGeoghan

References

This app was bootstrapped using this guide.