Aimene-BAHRI / farabi

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

private training school (ecole de formation)

License: MIT

Description:# Django Bootstrap 5 Volt Training School

This project is a web plateforme for School_managment made with Django Framework, it contains a CRUD managment for the school details and all its rubrics like the Parants, the students and all other staff and teachers. It contains an Invoice and Stock managments and a dashboard visualisation page.

Screenshots:

A HOME PAGE Bootstrap 5 UI:

Login UI:

Dashboard UI:

Dashboard Profile UI:

TODO:

  • Switch from sqlite to postgresql.
  • Minimize the Media Files size.
  • ADD a CRM to controle the Test and Exams results.

Tools & languages:

  • Visual Studio Code (IDE).
  • Python (Logic code).
  • Django template language (DTL) (UI Library).
  • HTML & CSS & BOOTSTRAP5 (UI Design).

✨ How to use it

$ # Get the code
$ git clone 
$ cd farabi
$
$ # Virtualenv modules installation (Unix based systems)
$ virtualenv env
$ source env/bin/activate
$
$ # Virtualenv modules installation (Windows based systems)
$ # virtualenv env
$ # .\env\Scripts\activate
$
$ # Install modules - SQLite Storage
$ pip3 install -r requirements.txt
$
$ # Create tables
$ python manage.py makemigrations
$ python manage.py migrate
$
$ # Start the application (development mode)
$ python manage.py runserver # default port 8000
$
$ # Start the app - custom port
$ # python manage.py runserver 0.0.0.0:<your_port>
$
$ # Access the web app in browser: http://127.0.0.1:8000/

Note: To use the app, please create a super user . After authentication, the app will unlock the private pages.



Step #1 - Install tools

  • NodeJS 12.x or higher
  • Gulp - globally
    • npm install -g gulp-cli
  • Yarn (optional)

Step #2 - Change the working directory to assets folder

$ cd apps/static/assets

Step #3 - Install modules (this will create a classic node_modules directory)

$ npm install
// OR
$ yarn

Step #4 - Edit & Recompile SCSS files

$ gulp scss

The generated file is saved in static/assets/css directory.


✨ Deployment

The app is provided with a basic configuration to be executed in Docker, Gunicorn, and Waitress.


Gunicorn 'Green Unicorn' is a Python WSGI HTTP Server for UNIX.

Install using pip

$ pip install gunicorn

Start the app using gunicorn binary

$ gunicorn --bind=0.0.0.0:8001 core.wsgi:application
Serving on http://localhost:8001

Visit http://localhost:8001 in your browser. The app should be up & running.



Waitress (Gunicorn equivalent for Windows) is meant to be a production-quality pure-Python WSGI server with very acceptable performance. It has no dependencies except ones that live in the Python standard library.

Install using pip

$ pip install waitress

Start the app using waitress-serve

$ waitress-serve --port=8001 core.wsgi:application
Serving on http://localhost:8001

Visit http://localhost:8001 in your browser. The app should be up & running.


✨ Credits & Links



Django Bootstrap 5 Volt - Provided by AppSeed App Generator.

About

License:Other


Languages

Language:Python 93.3%Language:HTML 2.8%Language:CSS 2.6%Language:SCSS 0.6%Language:JavaScript 0.6%Language:PowerShell 0.0%Language:Shell 0.0%Language:Roff 0.0%Language:Dockerfile 0.0%Language:Procfile 0.0%