diff --git a/README.md b/README.md index 6ec8ef50..77378714 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,226 @@ -# miniBase +Minibase_Readme +======================== +# Introduction +Minibase is a management tool for companies that need a high flexibility and manage interlaced projects. +In this Readme I will focus on the entry point and the structure of the main application. For more detailed information of each part you will find a separated Readme in each *module* *template* *Static* files etc... +**Hope You enjow it** -minimalist database interface For everyone +# Knowledge required to deploy Minibase +The list can be scary for but if you don't want to make some changes, some basic python and web knowlegde would de sufficient. +- [Python](https://www.python.org/) +- [Flask](https://flask.palletsprojects.com/en/3.0.x/) + - [flask-sqlalchemy](https://flask-sqlalchemy.palletsprojects.com/en/3.1.x/) + - [flask-wtf](https://flask-wtf.readthedocs.io/en/1.2.x/) + - [flask-session](https://flask-session.readthedocs.io/en/latest/) + - [flask-bcrypt](https://flask-bcrypt.readthedocs.io/en/1.0.1/) + - [flask-login](https://flask-login.readthedocs.io/en/latest/) + - [flask-mail](https://flask-mail.readthedocs.io/en/latest/) + - [flask-migrate](https://flask-migrate.readthedocs.io/en/latest/) + - [f] +- [Sql](https://en.wikipedia.org/wiki/SQL) +- [Postgres](https://www.postgresql.org/) +- [Docker](https://www.docker.com/)(Otpional) + - [Dockefile](https://docs.docker.com/guides/workshop/02_our_app/) + - [Docker-compose](https://docs.docker.com/compose/gettingstarted/) + - [Traefik](https://traefik.io/traefik/) +- [HTML](https://www.w3schools.com/html/) +- [CSS](https://www.w3schools.com/css/) +- [Bootsrap](https://getbootstrap.com/docs/5.3/getting-started/introduction/) -Can be used as : -Enterprise Resource Planning ERP. +# The struture +The main overwiev how the file structure is organised. This Flask Application is using [Blueprints](https://flask.palletsprojects.com/en/3.0.x/blueprints/) for modularity purposes. In odrder to not overencoumber this docuemntation I will isolate each blueprint and the main app. -I know that there are so many alternatives to minBase but the goal of this ERP is to be as user friendly as possible and scalable from simple inventory management up to Cloud Connected Inventory and project management. +```Bash +inibase/ +├── docker-compose.yml "Docker compose file to start create an start the container"(optinal) +├── LICENSE +├── README.md +└── web + ├── run.py "Entry point to the app ->" `python3 run.py` + ├── Dockerfile "Docker file to containerize the application"(optinal) + ├── requirments.txt "Python requirement." + └── minibase "Main App folder" + ├── app.py "Main application called by" `../run.py` + ├── config.py "Configurarion for Flask" + ├── theme.py "My approach to make a semi interractive color sheme and navbar menus" + ├── blueprints "Main Blueprint folder" + │ └── "Blueprint folder -> named as you like" + │ ├── forms.py "Definition of the forms to be used for the blueprint" + │ ├── models.py "Database models" + │ ├── routes.py "Routes for the html files and interractions for them" + │ ├── utils.py "Every Bluprint has it's functionalities coded here" + │ └── templates "Template folder for the current blueprint" + │ └── "Same as the blueprint name (this is a naming convention)" + │ └──