Skip to content

NITJSR-OSS/MemeCash

Repository files navigation

MemeCash - Hacktoberfest 2020

  • Update:

The website is now hosted on IPFS. Please visit the link below: MemeCash. Note 1: This is just a cdn for http://ipfs.infura.io/ipfs/Qmcq3Zu7sdfyFRwcexFuiwTVf1fLwwsDRSn7GMzgJ1U3V2 Note 2: In order to access this website, you need to have metamask extension installed in your browser.

meme

Hi! Welcome to this amalgamation of a lot of tech challenge for Hactoberfest. A project idea which just came out of nowhere and attempts to give its users free ethers (obviously test ether xD) in exchange for memes! (it's barter system all over again).

Everyone is encouraged to participate, regardless of your skill level (If you don't have the required skills, use this project as a motivation to learn those!). This is a practice project and should be considered a playground.

Project Summary

  • Project Vision:

vision

Please reference the presentation for the project here: Meme Cash Presentation

The project can be roughly divided into three sections:

  • A backend based on the ethereum blockchain and ipfs.

  • A react frontend.

  • A deep learning model that takes care of the photos (More on this later).

  • Expectations from you:

  • Some zeal and interest to work on the project.

  • Some basic Git knowledge.

Guidelines

System requirements:

  • Make sure node version 10 or higher is installed on your system.

  • Make sure npm version 6.14.4 or higher is installed on your system.

  • Make sure python version 3 or higher is installed on your system.

  • Make sure solidity version is 0.6.6 only.

Please try to follow these guidelines:

  • Use only CSS that too only flexbox, DON'T use bootstrap, material UI, semantic UI or any other styling library. (Haha! 😉 No shortcuts here 🤣)

  • Prefer functional components over class components for where state is not used.

  • Usage of Redux is a must (even though it involves a lot of boilerplate code)

  • Follow the styling guidelines for code: indentation (tab should be 4-space) and others (to be notified soon). Failure to follow the styling guidelines will result in your pull request not being accepted.

  • No code plagiarism. You're free to take help from the internet but code plagiarism will not be entertained.

  • Before adding/using any dependencies notify the project maintainers.

How to Contribute

Note 1: If you've never made a pull request before, or participated in an open-source project, we recommend taking a look at this wonderful video tutorial. And if you want a more complete tutorial on using github, creating branches etc. , here's a detailed video series.Once you've got your feet wet, you're ready to come back and dive into Hacktoberfest fun!

Note 2: Super Important Only the pull requests created between October 1st, 2020 and October 31st, 2020 will be counted!

  1. Star this repository. 😛

  2. And then you have to fork (make a copy) of this repo to your Github account.

  3. Clone (download) your fork to your computer.

  4. Set your streams so you can sync your clone with the original repo (get the latest updates)

  5. Create a branch with your name (for e.g: if your name is Bertram Gilfoyle, create a branch named Bertram_Gilfoyle).

  6. Make the changes in your branch.

  7. Commit and push the code to YOUR fork.

  8. Create a pull request to have the changes merged into the origin.

Running the project locally

After downloading this repo, run the command npm install in the project directory to install the dependencies.

Then cd into the meme-cash-frontend directory and run the command npm install again.

This project was bootstrapped with Create React App.

The commands below are super exclusive only to the meme-cash-frontend directory.

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.

Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.

You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.

See the section about running tests for more information.

npm build

Builds the app for production to the build folder.

It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.

Your app is ready to be deployed!

See the section about deployment for more information.

npm eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Code Splitting

This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting

Analyzing the Bundle Size

This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size

Making a Progressive Web App

This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app

Advanced Configuration

This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration

Deployment

This section has moved here: https://facebook.github.io/create-react-app/docs/deployment

npm build fails to minify

This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify

Lastly a shoutout to @AdityaPratap006 for the Readme template. Kudos to @prajwal72 for the project name.