Merge pull request #20 from scentmay/main

Main

Author: scentmay

README.md

@@ -1,99 +1,57 @@
-# WebApp boilerplate with React JS and Flask API
-
-[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io#https://github.com/4GeeksAcademy/react-flask-hello.git)
-
-> Documentation: https://start.4geeksacademy.com/
-
 <p align="center">
-<a href="https://www.loom.com/share/f37c6838b3f1496c95111e515e83dd9b"><img src="https://github.com/4GeeksAcademy/flask-rest-hello/blob/main/docs/assets/how-to.png?raw=true?raw=true" /></a>
+    <h1>S&F FIT</h1>
 </p>
 
-- React.js front end and python/flask backend for your web application.
-- Extensive documentation [here](https://start.4geeksacademy.com/).
-- Integrated with Pipenv for package managing.
-- Fast deloyment to heroku [in just a few steps here](https://start.4geeksacademy.com/backend/deploy-heroku-posgres).
-- Use of .env file.
-- SQLAlchemy integration for database abstraction.
-
-### Styles
-
-You can update the `styles/index.scss` or create new `.scss` files inside `styles/` and import them into your current scss or js files depending on your needs.
-
-### Components
-
-Add more files into your `./src/js/components` or styles folder as you need them and import them into your current files as needed.
-
-💡Note: There is an example using the Context API inside `views/demo.js`;
+APLICACIÓN PARA LA GESTIÓN DE INSTALACIONES DEPORTIVAS
+------------------------------------------------------------------------
+Se trata de una aplicación en la que se puede ver la gestión del dueño de las instalaciones así como la experiencia de uso de un usuario cliente que utiliza un smartphone para seguimiento de su rutina de entrenamiento.
 
-### Views (Components)
+Autores: Sergio Centenera Mayoral 🤝
+         Franco Piedrabuena
+         
+Tenemos multitud de ideas para la evolución de la aplicación proyectando una importante mejora en la zona de administración, con la realización de consultas para toma de decisiones.
 
-Add more files into your `./src/js/views` and import them in `./src/js/layout.jsx`.
+La parte de usuario incorporará un histórico de ejercicios así como la consulta de un feedback al cliente tras la realización de la rutina de entrenamiento. Estos datos proporcionarán la información complementaria a la aplicación para tener en cuenta en la próxima rotación de ejercicios que se le presente al cliente. Esta rotación también tendrá en cuenta las posibles lesiones o indicaciones médicas del cliente.
 
-### Context
+Incorporación de un cronómetro, integración con redes sociales para publicar los logros obtenidos en los entrenamientos, integración con servicios musicales para uso durante la sesión....las posibilidades son infinitas.
 
-This boilerplate comes with a centralized general Context API. The file `./src/js/store/flux.js` has a base structure for the store, we encourage you to change it and adapt it to your needs.
+Agradecer a todos los profesores, mentores y compañeros de 4Geeks Academy, gracias a todo@s vosotros esto ha sido posible.
+       
+Por supuesto, estamos abiertos a cualquier sugerencia en los correos:
 
-React Context [docs](https://reactjs.org/docs/context.html)
-BreathCode Lesson [view](https://content.breatheco.de/lesson/react-hooks-explained)
+📧 scentmay@gmail.com
 
-The `Provider` is already set. You can consume from any component using the useContext hook to get the `store` and `actions` from the Context. Check `/views/demo.js` to see a demo.
+📧 franconpiedrabuena@gmail.com
+ 
+Muestras de la aplicación 📌
+------------------------------------------------------------------------
+![Screenshot](screenshot_mainview.jpg) 
 
-```jsx
-import { Context } from "../store/appContext";
-const MyComponentSuper = () => {
-    //here you use useContext to get store and actions
-    const { store, actions } = useContext(Context);
-    return <div>{/* you can use your actions or store inside the html */}</div>;
-};
-```
+Página Home de la aplicación 💪
 
-### Back-End Manual Installation:
+![Screenshot](screenshot_home_expanded.jpg)
 
-It is recomended to install the backend first, make sure you have Python 3.8, Pipenv and a database engine (Posgress recomended)
+La aplicación cuenta con formularios protegidos con la tecnología de Formik ⬇🔐
 
-1. Install the python packages: `$ pipenv install`
-2. Create a .env file based on the .env.example: `$ cp .env.example .env`
-3. Install your database engine and create your database, depending on your database you have to create a DATABASE_URL variable with one of the possible values, make sure yo replace the valudes with your database information:
+![Screenshot](screenshot_protectedforms.jpg)
 
-| Engine    | DATABASE_URL                                        |
-| --------- | --------------------------------------------------- |
-| SQLite    | sqlite:////test.db                                  |
-| MySQL     | mysql://username:password@localhost:port/example    |
-| Postgress | postgres://username:password@localhost:5432/example |
+Zona usuario para su propia administración 🫵
 
-4. Migrate the migrations: `$ pipenv run migrate` (skip if you have not made changes to the models on the `./src/api/models.py`)
-5. Run the migrations: `$ pipenv run upgrade`
-6. Run the application: `$ pipenv run start`
+![Screenshot](screenshot_personal_data.jpg)
 
-### Backend Populate Table Users
+Entrenamientos a medida en su propio terminal 🏋️📱
 
-To insert test users in the database execute the following command:
+![Screenshot](screenshot_training_cards.jpg)
 
-```sh
-$ flask insert-test-users 5
-```
+Posibilidad de cambiar de suscripción en cualquier momento 💶💶
 
-And you will see the following message:
+![Screenshot](screenshot_usersuscription.jpg)
 
-```
-  Creating test users
-  test_user1@test.com created.
-  test_user2@test.com created.
-  test_user3@test.com created.
-  test_user4@test.com created.
-  test_user5@test.com created.
-  Users created successfully!
-```
+Útiles paneles de administración para el administrador de las instalaciones 📊🗓️
 
-To update with all yours tables you can edit the file app.py and go to the line 80 to insert the code to populate others tables
+![Screenshot](screenshot_clients_dashboard.jpg)
 
-### Front-End Manual Installation:
 
--   Make sure you are using node version 14+ and that you have already successfully installed and runned the backend.
 
-1. Install the packages: `$ npm install`
-2. Start coding! start the webpack dev server `$ npm run start`
 
-## Publish your website!
 
-This boilerplate it's 100% integrated with Herkou, [follow this tutorial](https://start.4geeksacademy.com/backend/deploy-heroku-posgres) and just by pushing your changes to the heroku repository will deploy the website afterwards.