Welcome to IoT-Spot 👋🎲

Website for IoT-Spot Project Repo: Click Here!

📌 Repository

An Amazing Spot to step your foot into this ocean of the "Internet Of things". Dive deep and explore the fiesta of electronics. Broaden your vision at a single go. Enjoy your open source journey!!.🚀

The main aim is to provide a cabin that would help you in mastering the "Internet Of Things" and making your hands dirty while exploring. An enriching field that makes your life turn smarter and be closer to technology. Turn yourself into a magician with all the hands-on that got you covered.

🙌 Join Here

Anyone related to technology who is looking to contribute to open-source is all invited to hop in. This place has a task for everyone.

| 8051 | ARM | Adafruit | Arduino | Atmel | Beagle | ESP32 | ESP8266 | Node MCU | PIC | Raspberry Pi |

Programming Lanaguages - C, C++, Python, HTML, CSS, JS

Domain Knowledge - IoT, Web Development

8051 Scripts - The best repo to start with before you enter into the ocean of micro-controllers. It has all the projects related to the 8051 micro-controller

ARM Scripts - This place is home to all the scripts based on ARM micro-controllers and gets involved in exclusive projects

Adafruit Scripts - This repo had all the scripts concerning Adafruit to gain more wisdom on it

Arduino Scripts - An all-time repo to scratch your cravings for Arduino and indulge in a better way

Atmel Scripts - It has all the scripts that are related to Atmel Micro-controllers to explore further

Beagle Scripts - This repo would have all the projects that use Beagle Boards/Bone to understand the scripts much deeper

ESP32 Scripts - This place would contain all the ESP32 scripts used in relevant projects

ESP8266 Scripts - This repo would have all the projects related to ESP8266 you can pick up for your references

Minor Scripts - This repo has all minor scripts put up together on various controllers we can use while working on IoT applications

NodeMCU Scripts - This repo has all NodeMCU scripts put up together that are widely useful in running automations

PIC Scripts - This place would have the scripts that use PIC micro-controller and are useful in building the functional projects concerning the same.

RaspberryPi Scripts - This repo has all the scripts that are compatible with all the versions and models of Raspberry Pi

Real-Time Scripts - This place endorses with all the scripts which take real-time inputs in parallel and makes the projects work functionally and promptly)

Major Scripts - This repo has all the major and impactful projects related to the Internet Of Things.

When raising an issue, do make sure to mention the kind of script, project title, short description of the project and how would you expect it to work. As a good practice, always link the issue number with a pull request. (#issue number: Give these details when you raise a PR).

If you worked on or want to initiate a unique project and share it with the world, you can do that here. Go through the contributing guidelines in CONTRIBUTING👩‍💻

Subsequently, also go through the GitHub documentation on creating a pull request.

🛠 Templates to Follow

Note: One should follow these templates while creating a new issue or pull request.

📝 Project Structure for IoT based Issues :

Your projects should contain this flow to maintain similarity across all other projects. Make sure to note these things, before you create a PR.

Create a folder of your project title. (Example: If you want to add a LED blinking using 8051, then the project should be placed under 8051 Scripts with project title named as "LED Blinking" and file name as "led_blinking.c" if it's a C file)

The project repository you had created would have :

file_name.py or file_name.c or file_name.cpp - This file is the project you have worked upon.

README.md - This file is must be included to get a good understanding of the project (Elaborate briefly about how it works using README template).

requirements.txt - In this file, you should add all the requirements you need to make your project work which also illustrates the list of all components used specifically

Images - This folder would have all images added, be it screenshots or step by step process images. Also, the inclusion of block diagrams and emulator circuit diagrams are a must to portray the project efficiently. Compilation video is also included.

Since this repo is purely technical, make sure you include "Block Diagrams" and "Emulator Prototype Circuit Diagrams" in "Images" and direct them to the README.md file

Related files - The other additional and related files would be added up in the "Related" folder.

📝 Project Structure for All Kind of Issues and PR's

Your projects should contain this flow to maintain similarity across all other projects. Make sure to note these things, before you create a issue or PR.

Create an issue with your idea, approach, your expected outcome and why it's useful to be necessary to be included in this project. For PR, include issue number along with PR template, it's details and compiled output screenshot

All the web related changes should go into IoT-Spot Website

⚙️ Things to Note

Make sure you do not copy codes from external sources because that work will not be considered. Plagiarism is strictly not allowed.
You can only work on issues that have been assigned to you.
If you want to contribute the script, it's preferable that you create a new issue before making a PR and link your PR to that issue.
If you have modified/added code, make sure the code compiles before submitting.
Strictly use snake_case (underscore_separated) in your file_name and push it in the correct folder.
Add Screenshots and block diagrams to help us know what this Script is all about.
Do not update the README.md.

💻 Workflow:

Fork the repository
Clone your forked repository using terminal or gitbash.
Make changes to the cloned repository
Add, Commit and Push
Then in GitHub, in your cloned repository, find the option to make a pull request.

print("Start contributing for IoT-Spot")

❄️ Open Source Programs

_{Social Summer Of Code 2022}

_{GirlScript Summer Of Code 2022}

_{Script Winter Of Code 2021}

_{Delta Winter Of Code 2021}

_{Hacktoberfest 2021}

🏆 Achievements of this Project Repo 🎉

1️⃣ Recognized as the "BEST PROJECT ADMIN" for the project 'IoT-Spot' in GirlScript Summer Of Code 2022.
2️⃣ Recognized as the "🥇 BEST ORGANIZATION" for "FIESTA OF PROJECTS" undertaking the project 'IoT-Spot' at Delta Winter Of Code for the year 2021-22.