GithubHelp home page GithubHelp logo

rajatsvn / xmeme_app Goto Github PK

View Code? Open in Web Editor NEW
0.0 2.0 0.0 110 KB

XMeme App created as a part of Crio's Winter of Doing Stage 2B

Home Page: https://xmeme-memestream.herokuapp.com/

CSS 40.53% JavaScript 39.09% Handlebars 15.22% Shell 4.89% Dockerfile 0.26%
tailwindcss nodejs express mongodb mongoose aws docker rest-api swagger

xmeme_app's Introduction

XMeme: The Meme Stream App

XMeme is a simple meme stream app in which you can

  • add a meme
  • edit your meme
  • watch a full meme stream
  • the app is publicly available and deployed Here

Tech

XMeme was made with โค๏ธ using the following technologies:

  • Tailwindcss - A utility-first css frameworks with css classes to be directly used in markup
  • Handlebars - An awesome templating engine
  • Node.js - Evented I/O for backend
  • Express - Fast Node.js network app framework
  • MongoDB - General purpose, document based NoSQL Database
  • Swagger - Document your Rest APIs seamlessly with Swagger Docs

Tools

These tools came in very handy while developing the application

  • Postman - Industry standard for everything to do with APIs
  • Robo 3T - GUI to connect to MongoDB database, formerly Robomongo

Installation on AWS EC2 Ubuntu 18.04 x86

  • Deploy an AWS EC2 Ubuntu 18.04 x86 VM from AWS Console

  • Go to EC2 Instances Dashboard and add rules to enable port 8080 and 8081

  • The Security group configuration should look like below:

Security Groups

  • ssh into the ec2 instance

  • git clone this repo using the following command

$ git clone repo_url_here
  • cd into the cloned repo

  • Setup the Server and run basic tests using the test_server.sh by typing the following command

$ chmod +x test_server.sh
$ sudo ./test_server.sh

Creating the Docker ๐Ÿณ Image

  • You can simply spin up the application using Docker locally by issuing this command from root of repo,
$ docker-compose up -d # Start as background process
$ # add sleep script , sleep 300 would be a good estimate
$ # add test script below 

Note: Please make sure you have docker and docker-compose installed on your system.

xmeme_app's People

Contributors

rajatsvn avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.