Giter Site home page Giter Site logo

memex's Introduction

XMeme

This project was build under Crio Winter of Doing Stage-2 Phase-B. This is a full-stack application. A user can create, read, update and delete memes in this app.

Tech Stack

Frontend - Flutter web

Backend - Node.js (Express.js)

Database - Posgress

Frontend

  • Provider Pattern for state management.
  • Widgets splitted in modular pieces.
  • models folder : contains meme model and response model. These are data wrappers.
  • MemeProvider : This is like controller and calls ApiProvider to get api response and notify view about data change.
  • MemeApiProvider : This calls API and handle processing response.
  • utils folder : This contains all the helper classes like logger, api_client, global variables, and helper class.
  • view : It contains all the UI of the app.
  • widgets folder : contains common widgets.
  • app_theme : contains theming and styles of the app.
  • main.dart : This starts the app. It is like index.js.
  • The website is responsive on different screen sizes.

Backend

  • MemeService : This service handles all the database operations and business logic of the app
  • Meme modal : This is the schema of our Meme table in postgress DB
  • MemeController : this controller glues everything together, service and the routes
  • config folder : this contains database, routes and server.js. Everything is setuped here.
  • ES6 syntax is used and compiled by babel for deployment.

Deployment

Frontend deployed on netlify - https://memex-dhruv.netlify.app/

Backend and database deployed on heroku - https://xmeme-backend-dhruv.herokuapp.com/

Additional tasks attempted

  1. HTTPS version for both frontend and backend
  2. Delete and update meme APIs and option for same in frontend.
  3. Swagger documentation available on http://localhost:8080/swagger-ui/
  4. Dockerized solution using docker-compose.yml

memex's People

Contributors

dhruv-garg79 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.