Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
## please follow the below rules for contributing

> <b>NOTE:</b> this project is using REACTJS18(latest version). so if you face some error try searching related to react 18

- use [BEM](https://www.freecodecamp.org/news/css-naming-conventions-that-will-save-you-hours-of-debugging-35cea737d849/) naming convention for the CSS class naming

- <strong>add comments to make it easier for others to understand</strong>

- write modular code and logical division of components in React

- try to make components more reusable

## please follow the below rules for contributing
> <b>NOTE:</b> this project is using REACTJS18(latest version). so if you face some error try searching related to react 18
- use [BEM](https://www.freecodecamp.org/news/css-naming-conventions-that-will-save-you-hours-of-debugging-35cea737d849/) naming convention for the CSS class naming
- <strong>add comments to make it easier for others to understand</strong>
- write modular code and logical division of components in React
- try to make components more reusable
- add your name to list of [contributors](CONTRIBUTORS.md) if not already added
20 changes: 10 additions & 10 deletions CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## Contributors ✨

Here's to the crazy ones:

<a href="https://github.com/DuP-491"><sub><b>Divyansh Upadhyay</b></sub></a>
<a href="https://github.com/dev-lovedeep"><sub><b>Lovedeep singh kamal</b></sub></a>
<a href="https://github.com/NeerajChatterjee"><sub><b>Neeraj Chatterjee</b></sub></a>
<a href="https://github.com/harshN-17"><sub><b>Harsh Narayan</b></sub></a>
<a href="https://github.com/ManishSheela"><sub><b>Manish Sheela</b></sub></a>

## Contributors ✨
Here's to the crazy ones:
<a href="https://github.com/DuP-491"><sub><b>Divyansh Upadhyay</b></sub></a>
<a href="https://github.com/dev-lovedeep"><sub><b>Lovedeep singh kamal</b></sub></a>
<a href="https://github.com/NeerajChatterjee"><sub><b>Neeraj Chatterjee</b></sub></a>
<a href="https://github.com/harshN-17"><sub><b>Harsh Narayan</b></sub></a>
<a href="https://github.com/ManishSheela"><sub><b>Manish Sheela</b></sub></a>
90 changes: 45 additions & 45 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,45 +1,45 @@
## Meme Generator 😆

A meme generator using react

meme images are taken from: https://api.imgflip.com/get_memes

![meme generator homepage image](meme-generator.png)

## How to run locally

open the terminal/command prompt at the location where you want to setup the project.

use the following commands in the terminal or command prompt:
```shell
git clone https://github.com/ContriHUB/Meme-Generator.git

cd Meme-Generator

npm i
```
once these command are completed successfully

do `npm start` to start the project


## Contributing

1. Fork this repo and clone it to your system.
2. Get the issue assigned to you on the ContriHUB website.
3. Make the required changes. Please keep your changes relevant only to the issue specified.
4. Add your name in the [CONTRIBUTORS.MD](CONTRIBUTORS.md) file
5. Create a PR with your changes and a detailed description of the changes you have made.
6. Submit the PR link on the ContriHUB website.

Read the [CONTRIBUTING](CONTRIBUTING.md) guide.
For major changes, please open an issue first to discuss what you would like to change.


## NOTE:
No external library is allowed for this project.

## Contributors
A list of contributors can be found in [CONTRIBUTORS.MD](CONTRIBUTORS.md)


## Meme Generator 😆
A meme generator using react
meme images are taken from: https://api.imgflip.com/get_memes
![meme generator homepage image](meme-generator.png)
## How to run locally
open the terminal/command prompt at the location where you want to setup the project.
use the following commands in the terminal or command prompt:
```shell
git clone https://github.com/ContriHUB/Meme-Generator.git
cd Meme-Generator
npm i
```
once these command are completed successfully
do `npm start` to start the project
## Contributing
1. Fork this repo and clone it to your system.
2. Get the issue assigned to you on the ContriHUB website.
3. Make the required changes. Please keep your changes relevant only to the issue specified.
4. Add your name in the [CONTRIBUTORS.MD](CONTRIBUTORS.md) file
5. Create a PR with your changes and a detailed description of the changes you have made.
6. Submit the PR link on the ContriHUB website.
Read the [CONTRIBUTING](CONTRIBUTING.md) guide.
For major changes, please open an issue first to discuss what you would like to change.
## NOTE:
No external library is allowed for this project.
## Contributors
A list of contributors can be found in [CONTRIBUTORS.MD](CONTRIBUTORS.md)
Loading