Skip to content

Commit 8600f0c

Browse files
committed
CleanUP - Minor
1 parent d35d69c commit 8600f0c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+197
-200
lines changed

app-generator.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,19 @@ description: AppSeed Generator - the visual interface.
66

77
> Note: **Service is still experimental** and generated products are not suitable for production
88
9-
The goal of this tool is to generate full-stack apps based on user choices: 
9+
The goal of this tool is to generate full-stack apps based on user choices:
1010

1111
* Design: the user can select the UI Kit
1212
* Backend Framework: Flask, Django, Nodejs or Laravel
13-
* UI Framework: Vue, React, Svelte 
14-
* Extra modules: Authentication type, database, payment modules etc.  
13+
* UI Framework: Vue, React, Svelte
14+
* Extra modules: Authentication type, database, payment modules etc.
1515

1616
### How to use it
1717

1818
* Access the [app generator](https://appseed.us/app-generator) page (no account required)
1919
* Select the frontend engine. You can choose from **Vue.js** and **React**
2020
* Select the preferred backend. You can choose from **Expres**, **Laravel,** and **Flask**
21-
* **Confirm the operation** 
21+
* **Confirm the operation**
2222
* After performing a few minimal tests the **deliverables** (zip archives) are ready for download
2323

2424

docs/content/bootstrap-template/adminator.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Adminator has a modern UI and comes with a _state-of-the-art_ tooling chain to c
2424
## How to compile the project
2525

2626
- A modern editor - [VSCode](https://code.visualstudio.com/)
27-
- [Nodejs](https://nodejs.org/en/) - used in [Javascript](https://developer.mozilla.org/en-US/docs/Web/JavaScript)-based products and tools 
27+
- [Nodejs](https://nodejs.org/en/) - used in [Javascript](https://developer.mozilla.org/en-US/docs/Web/JavaScript)-based products and tools
2828
- [GIT](https://git-scm.com/) - a command-line tool used to download sources from [Github](https://github.com/)
2929

3030
Once we have all these tools accessible we can start compiling the product:

docs/content/bulma-css-templates/dashkit-pro-v3.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Being a commercial product to get access to the source code please access the of
2121

2222
- A modern editor - [VSCode](https://code.visualstudio.com/)
2323
-[Nodejs](https://nodejs.org/en/) - used in [Javascript](https://developer.mozilla.org/en-US/docs/Web/JavaScript)-based products and tools
24-
- [Gulp](https://gulpjs.com/) - installed globally 
24+
- [Gulp](https://gulpjs.com/) - installed globally
2525

2626
Once all the tools are installed we can start compiling the code.
2727

docs/content/bulma-css-templates/dashkit-pro.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ description: Premium dashboard styled with Bulma CSS crafted by CssNinja agency.
1616
1717
- [Bulma CSS](https://bulma.io/) v0.9.1
1818
- [AlpineJs](https://github.com/alpinejs/alpine) - minimal framework for composing JavaScript behavior in your markup
19-
- [Spruce](https://github.com/ryangjchandler/spruce) **-** lightweight state management layer for Alpine.js \*\*\*\* 
19+
- [Spruce](https://github.com/ryangjchandler/spruce) **-** lightweight state management layer for Alpine.js
2020

2121
![Dashkit - Premium Bulma Dashboard.](../../../static/assets/dashkit-bulma-css.jpg)
2222

@@ -26,16 +26,16 @@ description: Premium dashboard styled with Bulma CSS crafted by CssNinja agency.
2626

2727
**Modular Code** - Dashkit's code is modular and lets you easily add and remove elements, to match your business specifications.
2828

29-
**Solid Layouts** -Multiple and different layouts are available to kickstart your app, like Chat, CRM and analytics products.  
29+
**Solid Layouts** -Multiple and different layouts are available to kickstart your app, like Chat, CRM and analytics products.
3030

3131
## How to compile DashKit
3232

33-
Being a commercial product to get access to the source code please access the official page and purchase a license. Once you have the source code downloaded a [minimal programming kit](../tutorials/minimal-programming-kit.mdx) should be properly installed and accessible in the terminal.  
33+
Being a commercial product to get access to the source code please access the official page and purchase a license. Once you have the source code downloaded a [minimal programming kit](../tutorials/minimal-programming-kit.mdx) should be properly installed and accessible in the terminal.
3434

3535
- A modern editor - [VSCode](https://code.visualstudio.com/)
3636
- [Nodejs](https://nodejs.org/en/) - used in [Javascript](https://developer.mozilla.org/en-US/docs/Web/JavaScript)-based products and tools
3737

38-
Once all the tools are installed we can start compiling the code. 
38+
Once all the tools are installed we can start compiling the code.
3939

4040
> **Step #1** - Change the directory inside the sources
4141

docs/content/how-to/django-add-debug-toolbar.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ if DEBUG: # <-- NEW
9292
mimetypes.add_type("application/javascript", ".js", True) # <-- NEW
9393
```
9494

95-
> **Step #4** - Execute the migration&#x20;
95+
> **Step #4** - Execute the migration
9696
9797
```bash
9898
$ python manage.py makemigrations
@@ -105,7 +105,7 @@ $ python manage.py migrate
105105
$ python manage.py runserver
106106
```
107107

108-
At this point, the Debug Toolbar should be visible on the right side for all pages.&#x20;
108+
At this point, the Debug Toolbar should be visible on the right side for all pages.
109109

110110
![Django Debug Toolbar - Soft UI Dashboard.](../../../static/assets/soft-ui-dashboard-django-toolbar.jpg)
111111

docs/content/how-to/django-dockerizing-app.mdx

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ sidebar_label: Django Dockerizing App
77

88
<SubHeading>How to setup a Django project to run in Docker</SubHeading>
99

10-
This page explains how to Dockerize a Django application with ease. For newcomers, Django is a leading web framework crafted in Python and Docker is a virtualization software used to isolate the execution of a service or product using virtual containers.&#x20;
10+
This page explains how to Dockerize a Django application with ease. For newcomers, Django is a leading web framework crafted in Python and Docker is a virtualization software used to isolate the execution of a service or product using virtual containers.
1111

1212
### Adding Docker
1313

@@ -46,7 +46,7 @@ CMD [ "python", "manage.py runserver 0.0.0.0:5000" ]
4646
EXPOSE 5000
4747
```
4848

49-
Once this is done, we can build the image and run it.&#x20;
49+
Once this is done, we can build the image and run it.
5050

5151
```bash
5252
$ docker build -t django_app .
@@ -57,13 +57,13 @@ You can now access your app on localhost:5000.
5757

5858
### Adding Docker Compose
5959

60-
If you want to create multiple images and run them using the precedent Docker configuration, you'll have to create multiple `Dockerfile`.&#x20;
60+
If you want to create multiple images and run them using the precedent Docker configuration, you'll have to create multiple `Dockerfile`.
6161

62-
`Docker Compose` saves from this by allowing you to use a `YAML` file to operate multi-container applications at once and run it just with one command.&#x20;
62+
`Docker Compose` saves from this by allowing you to use a `YAML` file to operate multi-container applications at once and run it just with one command.
6363

6464
Follow the official [documentation](https://docs.docker.com/compose/install/) to install `docker-compose` on your machine.
6565

66-
Once it's done, create a `docker-compose.yml` file at the root of your project. Make sure to have an `.env` file at the root of your project.&#x20;
66+
Once it's done, create a `docker-compose.yml` file at the root of your project. Make sure to have an `.env` file at the root of your project.
6767

6868
```yaml
6969
version: "3.8"
@@ -108,11 +108,11 @@ And your application will be running on localhost:5000.
108108
- Django App
109109
- short info regarding the codebase
110110
- Gunicorn - the WSGI server
111-
- &#x20;[gunicorn-cfg.py](https://github.com/app-generator/boilerplate-code-django-dashboard/blob/master/gunicorn-cfg.py)
112-
- Nginx - a powerful HTTP proxy&#x20;
113-
- &#x20;[appseed-app.conf](https://github.com/app-generator/boilerplate-code-django-dashboard/blob/master/nginx/appseed-app.conf)
111+
- [gunicorn-cfg.py](https://github.com/app-generator/boilerplate-code-django-dashboard/blob/master/gunicorn-cfg.py)
112+
- Nginx - a powerful HTTP proxy
113+
- [appseed-app.conf](https://github.com/app-generator/boilerplate-code-django-dashboard/blob/master/nginx/appseed-app.conf)
114114
- Dockerfile
115-
- How to bundle the information&#x20;
115+
- How to bundle the information
116116
- short description
117117
- sample - [Dockerfile](https://github.com/app-generator/boilerplate-code-django-dashboard/blob/master/Dockerfile)
118118
- Docker-compose

docs/content/how-to/django-reset-password.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@ sidebar_label: Django Reset Password
77

88
<SubHeading>A simple way to code a reset password mechanism in Django</SubHeading>
99

10-
This page explains how to implement a password reset mechanism in Django.&#x20;
10+
This page explains how to implement a password reset mechanism in Django.
1111

1212
Django comes with a password reset feature. You can extend these features to modify the default behavior.
1313

1414
For example, the `views` from `django.contrib.auth` comes with support for login, logout, and all the password reset flow.
1515

16-
&#x20;First of all, in the `urls.py`file, add the following routes.
16+
First of all, in the `urls.py`file, add the following routes.
1717

1818
```python
1919
from django.contrib.auth import views
@@ -27,7 +27,7 @@ urlpatterns = [
2727
]
2828
```
2929

30-
&#x20;These routes and views use the default Django templates.&#x20;
30+
These routes and views use the default Django templates.
3131

3232
But how do you use your own templates?
3333

docs/content/how-to/django-use-mysql.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ sidebar_label: Django MySql Database
1111

1212
### Django Database System
1313

14-
Django provides a generic way to access multiple database backends using a generic interface. In theory, Django empowers us to switch between DB Engines without updating the SQL code. The default SQLite database usually covers all requirements for small or demo projects but for production use, a more powerful database engine like **MySql** or **PostgreSQL** is recommended.&#x20;
14+
Django provides a generic way to access multiple database backends using a generic interface. In theory, Django empowers us to switch between DB Engines without updating the SQL code. The default SQLite database usually covers all requirements for small or demo projects but for production use, a more powerful database engine like **MySql** or **PostgreSQL** is recommended.
1515

1616
The database settings are saved in the file referred by `manage.py` file. For all Django starters, this file is saved inside the `core` directory:
1717

@@ -26,7 +26,7 @@ The database settings are saved in the file referred by `manage.py` file. For al
2626
| |-- urls.py # Define URLs served by all apps/nodes
2727
```
2828

29-
Let's visualize the contents of the `settings.py` file that configures the database interface.&#x20;
29+
Let's visualize the contents of the `settings.py` file that configures the database interface.
3030

3131
```python
3232
# File: core/settings.py
@@ -40,15 +40,15 @@ DATABASES = {
4040
...
4141
```
4242

43-
The above snippet is provided by when Django scaffolds the project. We can see that the **SQLite** driver is specified by the `ENGINE` variable.&#x20;
43+
The above snippet is provided by when Django scaffolds the project. We can see that the **SQLite** driver is specified by the `ENGINE` variable.
4444

4545
### Update for MySql
4646

4747
To use MySql as the backend engine for a Django project, we need to follow a simple setup:
4848

4949
- Install the **MySql Server** (we can also use a remote one)
5050
- Install the **Mysql** Python driver - used by Django to connect and communicate
51-
- Create the Mysql database and the user&#x20;
51+
- Create the Mysql database and the user
5252
- Update settings Django
5353
- Execute the Django migration and create the project tables
5454

@@ -63,13 +63,13 @@ The installation process is different on different systems but this phase should
6363

6464
### Install the Python Driver
6565

66-
To successfully access the Mysql Engine, Django needs a driver (aka a connector) to translate the Python queries to pure SQL instructions.&#x20;
66+
To successfully access the Mysql Engine, Django needs a driver (aka a connector) to translate the Python queries to pure SQL instructions.
6767

6868
```bash
6969
$ pip install mysqlclient
7070
```
7171

72-
The above instruction will install the Python MySql driver globally in the system. Another way is to use a `virtual environment` that sandboxes the installation.&#x20;
72+
The above instruction will install the Python MySql driver globally in the system. Another way is to use a `virtual environment` that sandboxes the installation.
7373

7474
```bash
7575
$ # Create and activate the virtual environment
@@ -127,7 +127,7 @@ DATABASES = {
127127

128128
### Start the project
129129

130-
The next step in our simple tutorial is to run the Django migration that will create all necessary tables.&#x20;
130+
The next step in our simple tutorial is to run the Django migration that will create all necessary tables.
131131

132132
```bash
133133
$ # Create tables
@@ -142,7 +142,7 @@ $ # Start the application (development mode)
142142
$ python manage.py runserver
143143
```
144144

145-
At this point, Django should be successfully connected to the Mysql Server and we can check the database and list the newly created tables during the database migration.&#x20;
145+
At this point, Django should be successfully connected to the Mysql Server and we can check the database and list the newly created tables during the database migration.
146146

147147
![Django - The default page](../../../static/assets/django-framework-cover.jpg)
148148

docs/content/how-to/python-crawl-website.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The code provided is fairly simple and to use it we need to be comfortable using
1515
- `PIP`, the official Python package manager
1616
- `requests` - a popular and simple HTTP library
1717
- `Beautiful Soup` - a library used to parse HTML and extract information with ease
18-
- 10minutes to understand and type the commands&#x20;
18+
- 10minutes to understand and type the commands
1919

2020
### Let's start writing code.
2121

docs/content/how-to/setup-windows-for-development.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ This guide is written for `Windows 10` version but can be used as a starting poi
2222
Visual Studio Code is a lightweight but powerful source code editor that runs on your desktop and is available for Windows, MacOS and Linux.
2323

2424
It comes with built-in support for JavaScript, TypeScript and Node.js and has a rich ecosystem of extensions for other languages (such as C++, C#, Java, Python, PHP, Go)
25-
and runtimes (such as .NET and Unity).&#x20;
25+
and runtimes (such as .NET and Unity).
2626

2727
- [Visual Studio Code](https://code.visualstudio.com/) - the official page
2828
- [Visual Studio Code](https://code.visualstudio.com/docs) - documentation
@@ -53,7 +53,7 @@ To install Git on Windows you will need to download the installer from the [Git]
5353

5454
- Download the installer
5555
- Execute the installer, using the default options
56-
- Test the installation by typing `git` &#x20;
56+
- Test the installation by typing `git`
5757

5858
```bash
5959
$ git

0 commit comments

Comments
 (0)