Git Product home page Git Product logo

meme-museum's Introduction

MEMES.PARTY

MEMES.PARTY is the de facto meme site in web3 to rate, curate, celebrate, and proliferate meme culture and memelords in perpetuity!

Tech stack overview

We are using WEB3.storage to upload the memes on IPFS and Filecoin in conjunction with TypeScript, Next.js and Chakra-UI on the front-end. The backend is powered by a Python API using Django & PostgreSQL (That might shift into a GraphQL API to allow discoverability of new memes and real-time updates using subscriptions/pub-sub).

๐Ÿ“ Folder structure

.
โ”œโ”€โ”€ packages # Monorepo using yarn workspaces & lerna
โ”‚ โ”œโ”€โ”€ contexts # Global  state  containing the  account, provider, etc
โ”‚ โ”œโ”€โ”€ components  # Dummy  &  functional compononents
โ”‚ โ”œโ”€โ”€ views # the main "views" of the app, meme modal, create meme modal, etc
โ”‚ โ””โ”€โ”€ styles # theming options
โ””โ”€โ”€ ... misc...

๐Ÿ„โ€โ™‚๏ธ Quick Start

Prerequisites

Clone the repo

$ git clone https://github.com/mmmgtc/meme-museum.git

Setup env

Create your .env files by copying the .example.env and fill in the empty values.

$ cd packages/[dapp, hardhat and schemas]
$ cp .example.env .env

Create your WEB3.storage account and API key

Go to https://web3.storage and set the value of WEB3STORAGE_TOKEN with your web3.storage API key.

  1. Login at the top right (Github or email/password)
  2. Go to account
  3. Create API key and copy it
  4. Paste/assign the value in your .env for the WEB3STORAGE_TOKEN key)

Install dependencies

$ cd meme-museum && yarn install

๐Ÿ‘ทโ€ Development

Start the ๐Ÿ“ฑ dApp:

$ yarn dev

๐Ÿ‘ทโ€ Build it!

Build the ๐Ÿ“ฑ dApp:

$ yarn build

Deploy

The dapp is automatically deployed for every change on the staging and main branches.

  • staging is the default development branch where features are being tested before being merged on main
  • main is the production branch

Running your development environment using docker

make up
make in
yard dev

Access via http://localhost:3000

meme-museum's People

Contributors

cali93 avatar giliomeejg avatar miralsuthar avatar nazeeh21 avatar sidcode avatar

Stargazers

 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.