melkotoury / zappy

MEAN Stack Twitter Slack Integration

Zappy

A Mean Stack Project which fetch Tweets using Slack Bot

Technologies

Zappy is a tool developed using NodeJS , ExpressJS , MongoDB as Backend Tools , Angular and Bootstrap as Frontend Tools Moreover I tried somehow to use the 12 factor app methodology on this app where I use git flow and docker for the app

Core

It is a tool which integrate two topnotch technologies such as Twitter and Slack, Where user can utilize it on any slack channel by typing the word ‘go’ , then the magic happens , tweets of a linked accounts will be fetched to the angular client in a real time manner .

How it works

1. Make sure you have node and npm installed on your machine by typing npm --version and node --version

2. Make sure that you have docker installed on your machine by typing docker --version ,also to ensure that docker-compose is working properly you may type docker-compose -vas we use it for starting our app.

3. The project is being splitted in two folders , first one is express-zappy which is the server side code for the app using node and express, the second part is the ng-zappy which contains the frontend code using angular

4. Make sure to check the .env.example file as a reference under the express_zappy directory , where it's required to add a new file in the express root directory named .env with the same variable as it's use by the app using the doetenv library and don't forget to provide your actual credentials.

5. The app is dockerized , and they way this project works is that we have 3 docker for each part of the app.

6. Two Docker containers are coming from two docker files are for the express and angular app respectively , and the third docker container is from docker hub image for mongodb

7. From our project root where docker compose yml file exists directory of our app simply run this command: docker-compose up . If it doesn't work just try preceiding it with sudo Express server will be running on port 3000 and Angular on port 4200