From ce8f219c28489161554bdeb522bca8aa2aa77273 Mon Sep 17 00:00:00 2001 From: lorenagubaira <102861577+Lorenagubaira@users.noreply.github.com> Date: Wed, 8 Jan 2025 19:59:33 -0400 Subject: [PATCH] python-hello template --- README.es.md | 23 ++++++++++++++--------- README.md | 21 +++++++++++++-------- learn.json | 2 +- 3 files changed, 28 insertions(+), 18 deletions(-) diff --git a/README.es.md b/README.es.md index ae3868df..1f55760e 100644 --- a/README.es.md +++ b/README.es.md @@ -1,7 +1,5 @@ # API de Lista de Tareas en Python Flask - - Este es un tutorial interactivo que te enseñará cómo crear una API usando el framework Python Flask y Pipenv @@ -10,21 +8,28 @@ Este es un tutorial interactivo que te enseñará cómo crear una API usando el ## 🌱 Cómo comenzar este proyecto -Este proyecto viene con los archivos necesarios para comenzar a trabajar de inmediato. +Hay dos formas de empezar: -Recomendamos abrir este mismo repositorio usando un entorno de desarrollo como [Codespaces](https://4geeks.com/es/lesson/tutorial-de-github-codespaces) (recomendado) o [Gitpod](https://4geeks.com/es/lesson/como-utilizar-gitpod). Alternativamente, puedes clonarlo en tu computadora local usando el comando `git clone`. +a) Abrir este enlace con [Codespaces](https://4geeks.com/es/lesson/tutorial-de-github-codespaces) (recomendado) o [Gitpod](https://4geeks.com/es/lesson/como-utilizar-gitpod) en tu navegador: https://github.com/codespaces/new/?repo=4GeeksAcademy/python-hello -Este es el repositorio que necesitas abrir: +b) Clonar este repositorio localmente en tu computador: -```text -https://github.com/breatheco-de/python-flask-api-tutorial +```sh +$ git clone https://github.com/4GeeksAcademy/python-hello ``` -**👉 Por favor sigue estos pasos sobre** [cómo comenzar un proyecto de programación](https://4geeks.com/es/lesson/como-comenzar-un-proyecto-de-codificacion). +### Pasos + +- Si trabajas localmente, debe tener python [instalado](https://4geeks.com/es/how-to/como-instalar-python). + +- Deberías abrir el terminal en la ruta de esta plantilla y ejecutar `$ python3 app.py`, si todo funciona correctamente, debería mostrar `Hello World` en el terminal. -> 💡 Importante: Recuerda guardar y subir tu código en GitHub creando un nuevo repositorio, actualizando el remoto (`git remote set-url origin `) y subiendo el código a tu nuevo repositorio usando los comandos `add`, `commit` y `push` desde la terminal de git. +- Puedes probar tu código escribiendo `$ python3 test.py`. + +💡 Importante: Recuerda actualizar el `remote` del proyecto con el de tu repositorio usando `git remote set-url origin `, y luego guardar tu código en tu nuevo repositorio usando `add`, `commit` y `push`. + ## Acerca del proyecto que vamos a construir En este tutorial, crearemos una API REST que expone 3 endpoints a Internet: diff --git a/README.md b/README.md index a43583c8..0a74e777 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,5 @@ # Todo List API in Python Flask - This is an interactive tutorial that will teach you how to create an API using the Flask framework on Python and Pipenv. @@ -9,19 +8,25 @@ This is an interactive tutorial that will teach you how to create an API using t ## 🌱 How to start this project -This project comes with the necessary files to start working immediately. +There are 2 ways to start: -We recommend opening this very same repository using a provisioning tool like [Codespaces](https://4geeks.com/lesson/what-is-github-codespaces) (recommended) or [Gitpod](https://4geeks.com/lesson/how-to-use-gitpod). Alternatively, you can clone it on your local computer using the `git clone` command. +a) Open this link in your browser with [Codespaces](https://4geeks.com/lesson/what-is-github-codespaces) (recommended) or [Gitpod](https://4geeks.com/lesson/how-to-use-gitpod): https://github.com/codespaces/new/?repo=4GeeksAcademy/python-hello -This is the repository you need to open: +b) You can clone this repository on your local computer: -```text -https://github.com/breatheco-de/python-flask-api-tutorial +```bash +$ git clone https://github.com/4GeeksAcademy/python-hello ``` -**👉 Please follow these steps on** [how to start a coding project](https://4geeks.com/lesson/how-to-start-a-project). +### Steps -> 💡 Important: Remember to save and upload your code to GitHub by creating a new repository, updating the remote (`git remote set-url origin `), and uploading the code to your new repository using the `add`, `commit` and `push` commands from the git terminal. +- If working locally, you should have python [installed](https://4geeks.com/how-to/how-to-install-python). + +- You should open the terminal on the path of this template and run `$ python3 app.py`, if everything works correctly, it should show `Hello World` on the terminal. + +- You can test your code by typing: `$ python3 test.py`. + +💡 Important: Remember to create a new repository, update the remote (`git remote set-url origin `), and upload the code to your new repository using `add`, `commit` and `push`. diff --git a/learn.json b/learn.json index 52819cdc..c77aa403 100644 --- a/learn.json +++ b/learn.json @@ -6,7 +6,7 @@ "repository": "https://github.com/breatheco-de/python-flask-api-tutorial", "preview": "https://github.com/breatheco-de/python-flask-api-tutorial/blob/master/.learn/assets/preview.png?raw=true", "duration": 6, - "template_url": "self", + "template_url": "https://github.com/4GeeksAcademy/python-hello", "grading": "incremental", "difficulty": "beginner", "videoSolutions": false,