yashnirmal / easter-eggs Goto Github PK

• Welcome to Easter Eggs
• Tech Stack
• How to Contribute

Easter Eggs is a website where you can find easter eggs of all kinds.

There are 2 ways you can contribute to the project

1. Adding new feature or solving bugs
2. Adding new Easter eggs

1. Fork the project

2. Clone the project to run on your local machine using the following command

   git clone https://github.com/<your_github_username>/easter-eggs.git

3. Get into the root directory

   cd easter-eggs

4. Install all dependencies by running

   npm install

5. Create your branch

   git checkout -b <your_branch_name>

6. To run and view the application on localhost

   npm run dev

7. Push your changes into your branch

   git push origin <your_branch_name>

8. Create a Pull Request

1. Follow step (1 to 5) from above

2. Inside the components/easter-eggs/ folder you can add you easter egg

3. Create new folder name your_easter_egg_number-/your-easter-egg-name

4. Go inside that folder

5. Your Easter egg will require a box like this

   For that make a js file your-easter-egg-name.js

6. Then to make a file containing your easter egg name easter.js

7. You can check and use demo folder as an example. You can also copy paste this demo folder for your easter egg and make required changes

8. If your easter egg require use of something written in the search bar you can use context api for that. That too is shown in demo folder

9. After adding the easter eggs, push your changes into your branch

   git push origin <your_branch_name>

10. Finally, create a Pull Request