Skip to content
This repository was archived by the owner on Mar 21, 2025. It is now read-only.

Commit 7a1a1a2

Browse files
ediardoediardo
committed
Hello World 🌎
0 parents  commit 7a1a1a2

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

65 files changed

+18727
-0
lines changed

‎.gitignore

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
2+
3+
# dependencies
4+
/node_modules
5+
/.pnp
6+
.pnp.js
7+
8+
# testing
9+
/coverage
10+
11+
# production
12+
/build
13+
14+
# misc
15+
.DS_Store
16+
.env.local
17+
.env.*
18+
.env.development.local
19+
.env.test.local
20+
.env.production.local
21+
22+
npm-debug.log*
23+
yarn-debug.log*
24+
yarn-error.log*

‎CODE-OF-CONDUCT.md

+132
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, caste, color, religion, or sexual
10+
identity and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the overall
26+
community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or advances of
31+
any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email address,
35+
without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
[email protected].
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series of
86+
actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or permanent
93+
ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within the
113+
community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.1, available at
119+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
120+
121+
Community Impact Guidelines were inspired by
122+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
123+
124+
For answers to common questions about this code of conduct, see the FAQ at
125+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
126+
[https://www.contributor-covenant.org/translations][translations].
127+
128+
[homepage]: https://www.contributor-covenant.org
129+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
130+
[Mozilla CoC]: https://github.com/mozilla/diversity
131+
[FAQ]: https://www.contributor-covenant.org/faq
132+
[translations]: https://www.contributor-covenant.org/translations

‎CONTRIBUTING.md

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Contributing to ExplainDev projects
2+
3+
A big welcome and thank you for considering contributing to ExplainDev open source projects! It’s people like you that make it a reality for users in our community.
4+
5+
Reading and following these guidelines will help us make the contribution process easy and effective for everyone involved. It also communicates that you agree to respect the time of the developers managing and developing these open source projects. In return, we will reciprocate that respect by addressing your issue, assessing changes, and helping you finalize your pull requests.
6+
7+
## Quicklinks
8+
9+
* [Code of Conduct](#code-of-conduct)
10+
* [Getting Started](#getting-started)
11+
* [Issues](#issues)
12+
* [Pull Requests](#pull-requests)
13+
* [Getting Help](#getting-help)
14+
15+
## Code of Conduct
16+
17+
We take our open source community seriously and hold ourselves and other contributors to high standards of communication. By participating and contributing to this project, you agree to uphold our [Code of Conduct](https://github.com/explaindev/tutorial-maker/blob/master/CODE-OF-CONDUCT.md).
18+
19+
## Getting Started
20+
21+
Contributions are made to this repo via Issues and Pull Requests (PRs). A few general guidelines that cover both:
22+
23+
* Search for existing Issues and PRs before creating your own.
24+
* We work hard to makes sure issues are handled in a timely manner but, depending on the impact, it could take a while to investigate the root cause. A friendly ping in the comment thread to the submitter or a contributor can help draw attention if your issue is blocking.
25+
26+
### Issues
27+
28+
Issues should be used to report problems with the library, request a new feature, or to discuss potential changes before a PR is created. When you create a new Issue, a template will be loaded that will guide you through collecting and providing the information we need to investigate.
29+
30+
If you find an Issue that addresses the problem you're having, please add your own reproduction information to the existing issue rather than creating a new one. Adding a [reaction](https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) can also help be indicating to our maintainers that a particular problem is affecting more than just the reporter.
31+
32+
### Pull Requests
33+
34+
PRs to our libraries are always welcome and can be a quick way to get your fix or improvement slated for the next release. In general, PRs should:
35+
36+
* Only fix/add the functionality in question **OR** address wide-spread whitespace/style issues, not both.
37+
* Add unit or integration tests for fixed or changed functionality (if a test suite already exists).
38+
* Address a single concern in the least number of changed lines as possible.
39+
* Include documentation in the repo.
40+
* Be accompanied by a complete Pull Request template (loaded automatically when a PR is created).
41+
42+
For changes that address core functionality or would require breaking changes (e.g. a major release), it's best to open an Issue to discuss your proposal first. This is not required but can save time creating and reviewing changes.
43+
44+
In general, we follow the ["fork-and-pull" Git workflow](https://github.com/susam/gitpr)
45+
46+
1. Fork the repository to your own Github account
47+
2. Clone the project to your machine
48+
3. Create a branch locally with a succinct but descriptive name
49+
4. Commit changes to the branch
50+
5. Following any formatting and testing guidelines specific to this repo
51+
6. Push changes to your fork
52+
7. Open a PR in our repository and follow the PR template so that we can efficiently review the changes.
53+
54+
## Getting Help
55+
56+
Join us in the [Discord Community](https://discord.gg/JTU2v6TtPv) and post your question there in the correct category with a descriptive tag.

‎LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2022 ExplainDev Inc
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

+105
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
# ExplainDev Tutorial Maker
2+
3+
Instead of wasting time thinking of a better name, we use our time to make this awesome little project *opensource*.
4+
5+
Tutorial Maker helps you create those beautiful images of code people share on Internet, explained with AI.
6+
7+
## Demo
8+
9+
Demo video: [watch on YouTube](https://www.youtube.com/watch?v=LcKhSe0iVyA).
10+
11+
### Examples
12+
13+
Most text in the images below was written by AI.
14+
15+
#### Tutorial JavaScript
16+
17+
![Tutorial JavaScript](./examples/javascript.png)
18+
19+
#### Tutorial grep
20+
21+
![Tutorial grep](./examples/grep.png)
22+
23+
#### Tutorial HTML Links
24+
25+
![Tutorial HTML](./examples/html.png)
26+
27+
#### Tutorial Docker containers
28+
29+
![Tutorial Docker](./examples/docker.png)
30+
31+
## Features
32+
33+
### 💥 Add code blocks and text elements
34+
35+
### 🤖 Explain code with AI
36+
37+
### 🖼️ Download tutorial as an png image
38+
39+
### ↔️ Resize, position and change color of elements
40+
41+
### 🌈 Custom background using plain CSS directives
42+
43+
### 🪄 Code Syntax Highlighting
44+
45+
## Development
46+
47+
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
48+
49+
In the project directory, you can run:
50+
51+
### `npm start`
52+
53+
Runs the app in the development mode.
54+
55+
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
56+
57+
The page will reload if you make edits.
58+
You will also see any lint errors in the console.
59+
60+
### `npm run build`
61+
62+
Builds the app for production to the `build` folder.
63+
It correctly bundles React in production mode and optimizes the build for the best performance.
64+
65+
The build is minified and the filenames include the hashes.
66+
67+
## Contributing
68+
69+
Please, read our contributing guidelines and code of conduct.
70+
71+
## To-do list
72+
73+
### Decouple explanation boxes from ExplainDev service
74+
75+
Goal: Users should be able to highlight explain code without the help of AI.
76+
77+
AI explanations are awesome, but sometimes expensive, innacurate or simply unnecessary. We know some users would love to add explanations themselves. We believe that this feature should be optional.
78+
79+
### Testing
80+
81+
Goal: Develop a robust testing framework that prevents introducing breaking changes.
82+
83+
Tests weren't a priority in the MVP phase but we aspire to grow Tutorial Maker into a mature project. Ideas for testing the webapp are welcome.
84+
85+
### Store tutorials
86+
87+
Goal: Save tutorials so that you can recover them later.
88+
89+
Store tutorials in any storage. In order to make it happen, we'd need to serialize the state of the canvas and its elements, for example, the content of code blocks, position, colors, etc.
90+
91+
### Decouple login from ExplainDev service
92+
93+
Goal: Use any authentication provider
94+
95+
### Docs
96+
97+
Goal: make it easier for new folks to start contributing to this project
98+
99+
## Learn more
100+
101+
We’re welcoming everyone in our community to contribute to the tutorial maker and would love your input in whatever capacity you thrive in. I’ll be building out the contribution guidelines in the days to come in order to make it easier to get started. We welcome discussion on Discord!
102+
103+
* [Discord Community](https://discord.gg/JTU2v6TtPv)
104+
* [Twitter](https://twitter.com/explain_dev)
105+
* [YouTube](https://www.youtube.com/channel/UCO9-BA8YMaZG8qdHAVk0OOA/featured)

‎babel-plugin-macros.config.js

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
module.exports = {
2+
'fontawesome-svg-core': {
3+
'license': 'free'
4+
}
5+
}

‎babel.config.js

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
module.exports = function (api) {
2+
return {
3+
plugins: ['macros'],
4+
}
5+
}

‎examples/docker.png

56.9 KB
Loading

‎examples/grep.png

236 KB
Loading

‎examples/html.png

137 KB
Loading

‎examples/javascript.png

41.6 KB
Loading

‎examples/placeholder.png

104 KB
Loading

0 commit comments

Comments
 (0)