mehulthakral / xmeme

Xmeme - Meme Stream Application

Introduction

A Full Stack Application for storing and retrieving memes - XMeme

Tech Stack:

• FrontEnd - HTML + CSS + BootStrap + JQuery - Deployed on Netlify
• BackEnd - Flask - Deployed on Heroku
• DataBase - MySql
• Documentation of APIs - Swagger(OpenApi 3)

Ways to run the Application

1. chmod +x test_server.sh & ./test_server.sh - Will do necessary installations, runs the server and demonstrates basic functionalities using curl requests
2. Steps:
   
   1. chmod +x install.sh & sudo ./install.sh - Will install MySql(On prompted to set MySql Root password - Just press enter) and necessary python packages
   2. chmod +x server_run.sh & ./server_run.sh & - Will run the server in the backend
   3. cd frontend and open index.html - for launching frontend
   4. curl --location --request GET 'http://localhost:8080/swagger-ui/' - Will fetch Swagger API documentation in JSON format - can be used for backend requests
3. sudo docker-compose up --build - To run backend using docker