Added tutorial

This commit is contained in:
Antonio de la Rosa 2024-05-27 23:50:26 +02:00
parent d5d19e009a
commit 59daf588ae

110
docs/tutorial.md Normal file
View file

@ -0,0 +1,110 @@
## Creando un nuevo website
Para crear un nuevo website con paramecio2 debe de usar el comando instalado `paramecio2`
Introduzca en su linea de comandos lo siguiente:
user@localhost: paramecio2 --help
usage: paramecio2 [-h] --path PATH [--modules MODULES] [--symlink] [--url URL] [--folder FOLDER]
A tool for create new paramecio2 sites
options:
-h, --help show this help message and exit
--path PATH The path where the paramecio site is located
--modules MODULES A list separated by commas with the git repos for download modules for this site
--symlink Set if create direct symlink to paramecio in new site
--url URL The http/https base url of the real proxy server. Example: https://www.exampledomain.com, default is http://localhost:5000
--folder FOLDER If you deploy in a subdirectory, set it, without beggining and ending slashes
El único parametro requerido es `--path`, que indica la carpeta donde será guardado su nuevo sitio.
Ejemplo: `paramecio2 --path site`
Aparecerán diversas opciones para contestar:
- Email for site:
Con esta opción puede añadir un correo por defecto que será usado para algunas cuestiones internas de envío de emails.
- Do you want use paramecio with MySQL database? y/n:
Esta opción es para añadir una base de datos MariaDB/MySQL al sistema.
> Recuerde que MariaDB es una base de datos compatible con MySQL y es la recomendada por parte de los desarrolladores para su uso con Paramecio2.
Si se elige `y`(sí) aparecerán unas nuevas opciones para configurar la base de datos del nuevo website con paramecio2:
- MySQL database server host, by default localhost:
Añada el servidor de datos mysql para el website creado con paramecio2. Por defecto es el servidor de bases de datos local.
- MySQL database name, by default paramecio_db:
El nombre de la base de datos que se usará para paramecio2. Si no existe, el sistema intentará crearla.
- MySQL database user, by default root:
El usuario de la base de datos, por defecto, el usuario root.
- MySQL database password, by default "":
La contraseña de la base de datos. Por defecto, se deja en blanco.
- Do you want create admin site? y/n:
Si elegiste usar una base de datos MySQL, podrás tener opción para crear una zona de administración, a la que se podrá añadir módulos usando flask y la aplicación wsgi admin_app.
Si todo va bien, obtendremos este mensaje final:
`Created admin site...`
Una vez visto ese mensaje, podremos acceder al administrador de nuestro nuevo sitio y podremos crear al usuario administrador.
## Iniciando el nuevo website.
Si el path usado para el nuevo sistema paramecio2 es `site`, podremos entrar a una carpeta llamada así dentro del directorio donde ejecutamos el comando `paramecio2`.
Con flask, podemos hacer usar su entorno de desarrollo, usando el comando `flask`.
Entramos en `site`. Usando Linux por ejemplo:
cd site
Ahora ejecutamos el comando `flask`:
flask --app app run --debug
Debería aparecer lo siguiente:
* Serving Flask app 'app'
* Debug mode: on
WARNING: This is a development server. Do not use it in a production deployment. Use a production WSGI server instead.
* Running on http://127.0.0.1:5000
Press CTRL+C to quit
* Restarting with watchdog (inotify)
* Debugger is active!
* Debugger PIN: 537-905-394
Si no da error, ya tienes instalado correctamente un sitio usando `Paramecio2 framework`.
## Creando un nuevo usuario para el administrador.
Si creaste el sitio con un administrador, podrás acceder a él en esta dirección web por defecto:
http://localhost:5000/admin
Obviamente deberás cambiar la URL a la dirección con la que configuraste Paramecio2.
Más información sobre Flask: (https://flask.palletsprojects.com/en/3.0.x/)