Merge pull request #63 from tecladocode/jose/prepare-repo-public

Author: jslvtr

.pre-commit-config.yaml

@@ -0,0 +1,41 @@
+# Contributing guide
+
+Create a virtual environment and install the Python dev dependencies:
+
+```
+python3.9 -m venv .venv
+source .venv/bin/activate
+pip install -r requirements-dev.txt
+```
+
+This installs Black and flake8. Use Black to format any Python code you include in your contributions, and run the code through the flake8 linter to catch any errors.
+
+Then, set up the Vuepress project:
+
+```
+npm install
+```
+
+That should install everything.
+
+## Run
+
+To run the project e-book locally, you can just do:
+
+```
+npm run cur:dev
+```
+
+## How to start contributing
+
+Please don't just submit a PR with your contributions before talking about it with the Teclado team!
+
+First, start off by creating an [issue](/issues) with what you'd like to contribute and why. The more information you can give at this stage, the better.
+
+Then we can talk about the contribution idea and plan in the issue itself. Once we've decided to go ahead and how to go ahead, we can begin implementing the changes.
+
+For your changes, please use the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) standard when writing commit messages. It really helps the team understand what each commit does when going through the changes.
+
+After the changes are implemented in a fork, you can submit a PR to the repo. At that point we would review the PR and offer feedback and suggestions, if we have any. Once we're all happy with the changes offered in the PR, we can merge it into this main repository!
+
+Thank you very much for your support and contributions! 💪

CONTRIBUTING.md

@@ -1,36 +1,41 @@
 # Web Developer Bootcamp with Flask and Python
 
-Thank you for checking out the course code!
+<p align="center">
+ <img src="assets/course-image.png" alt="Web Developer Bootcamp with Flask and Python (Udemy banner image)"></a>
+</p>
 
-Access the course notes here: https://python-web.teclado.com
+<div align="center">
 
-## Contributing
+[![Udemy rating 4.6/5](https://img.shields.io/badge/udemy-4.6%2F5-brightgreen)](https://go.tecla.do/web-dev-course-sale) ![GitHub last commit](https://img.shields.io/github/last-commit/tecladocode/python-web-2020) ![Python 3.10](https://img.shields.io/badge/python-3.10-yellow) [![Discord](https://img.shields.io/discord/614395983807250433)](https://discord.gg/78Nvd3p) [![Twitter Follow](https://img.shields.io/twitter/follow/jslvtr?style=social) ](https://twitter.com/jslvtr)
+
+</div>
+
+---
+
+<p align = "center">💡 A full course to teach you how to use Flask, Python, and MongoDB to make complete, dynamic websites.</p>
 
-Install Python requirements with Pipenv:
+<p align = "center">📖 Read the e-book <a href="https://python-web.teclado.com">here</a>.</p>
 
-```
-pipenv install
-```
+## Getting started
 
-Then use `pre-commit` to set up the Python formatter hooks (this will run Black on any Python files before you commit):
+Enrol in the course by going to [this link](https://go.tecla.do/web-dev-course-sale).
 
-```
-pipenv shell
-pre-commit install
-```
+Then you can come back here to download the repository, although it is not necessary. Everything you need is available in the e-book (link above).
 
-Then, set up the Vuepress project:
+If you are familiar with Git, you can use Git to download it. Otherwise, you can download it as a zip file:
 
-```
-npm install
-```
+![Download repo as a zip file](assets/download-repo-zip.png)
 
-That should install everything!
+Next, start taking the course at the beginning! You can use the downloaded code files and [the e-book](https://python-web.teclado.com) to support you while you go through the course.
 
-## Run
+I also **strongly recommend** you code while you take the course. A good strategy is:
 
-To run the project, you can just do:
+1. Watch the video intently, optionally while taking notes.
+2. Watch again, more quickly, while typing the code together with me.
+3. Once you're done with the video, play about with the code. Make changes, break things, then fix them, and try to thoroughly understand everything the code does.
+
+If you do this for the entire course, I guarantee you will learn how to make dynamic web apps using Flask and Python well. You'll still be using Google and searching for stuff every day, but so does everyone else!
+
+## Contributing
 
-```
-npm run cur:dev
-```
+If you'd like to contribute to this course or e-book, please read the [CONTRIBUTING.md](CONTRIBUTING.md) file to get started!

Pipfile

@@ -0,0 +1,2 @@
+black
+flake8