Skip to content

Commit 80f3841

Browse files
committed
broken links fixed
1 parent 647ae78 commit 80f3841

File tree

155 files changed

+565
-586
lines changed

Some content is hidden

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

155 files changed

+565
-586
lines changed

docs/boilerplate-code/api-server/api-unified-definition.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ This page describes the **unified definition** used by all API servers provided
1414

1515
> API Servers aligned to use it:
1616
17-
- [API Server Django](django.md) - free product
18-
- [API Server Flask](flask.md) - free product
19-
- [API Server Node JS](node-js.md) - free product
17+
- [API Server Django](django.mdx) - free product
18+
- [API Server Flask](flask.mdx) - free product
19+
- [API Server Node JS](node-js.mdx) - free product
2020
- [API Server Node JS PRO](https://github.com/app-generator/api-server-nodejs-pro) - commercial product
2121

2222
> UI Products aligned to use it:

docs/boilerplate-code/api-server/django.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,13 @@ Simple starter built with Python / Django Rest / Sqlite3 and JWT Auth. The authe
1616
[**v1.0.2**](https://github.com/app-generator/api-server-django/releases), release date `2022-06-07`
1717
:::
1818

19-
- [API Definition](api-unified-definition.md) - the unified API structure implemented by this server
19+
- [API Definition](api-unified-definition.mdx) - the unified API structure implemented by this server
2020
- [Django API Server](https://github.com/app-generator/api-server-django) - source code
2121
- Full-stack samples compatible with this product:
2222
- [React Berry Dashboard](https://github.com/app-generator/react-berry-admin-template) - open-source sample
2323
- [React Datta Dashboard](https://github.com/app-generator/react-datta-able-dashboard) - open-source sample
2424

25-
> API Methods - for full description please access [API Unified Definition](api-unified-definition.md)
25+
> API Methods - for full description please access [API Unified Definition](api-unified-definition.mdx)
2626
2727
- USERS API:
2828
- `/api/users/register`: create a new user

docs/boilerplate-code/api-server/flask.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@ Simple [Flask API Boilerplate](https://appseed.us/boilerplate-code/flask-api-boi
1515
[**v1.0.2**](https://github.com/app-generator/api-server-flask/releases), release date `2022-06-07`
1616
:::
1717

18-
- [API Definition](api-unified-definition.md) - the unified API structure implemented by this server
18+
- [API Definition](api-unified-definition.mdx) - the unified API structure implemented by this server
1919
- [Flask API Server](https://github.com/app-generator/api-server-flask) - source code
2020
- Full-stack samples compatible with this product:
2121
- [React Berry Dashboard](https://github.com/app-generator/react-berry-admin-template) - open-source sample
2222
- [React Datta Dashboard](https://github.com/app-generator/react-datta-able-dashboard) - open-source sample
2323

24-
> API Methods - for full description please access [API Unified Definition](api-unified-definition.md)
24+
> API Methods - for full description please access [API Unified Definition](api-unified-definition.mdx)
2525
2626
- USERS API:
2727
- `/api/users/register`: create a new user
@@ -109,7 +109,7 @@ api-server-flask/
109109
│ ├── models.py
110110
│ └── routes.py
111111
├── Dockerfile
112-
├── README.md
112+
├── README.mdx
113113
├── requirements.txt
114114
├── run.py
115115
└── tests.py

docs/boilerplate-code/api-server/node-js.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,13 @@ Free API Server coded on top of Express / Node JS with **SQLite** persistence an
1616
[**v1.0.1**](https://github.com/app-generator/api-server-nodejs/releases), release date `2022-06-02`
1717
:::
1818

19-
- [API Definition](api-unified-definition.md) - the unified API structure implemented by this server
19+
- [API Definition](api-unified-definition.mdx) - the unified API structure implemented by this server
2020
- [Node JS API Server](https://github.com/app-generator/api-server-nodejs) - source code
2121
- Full-stack samples compatible with this product:
2222
- [React Berry Dashboard](https://github.com/app-generator/react-berry-admin-template) - open-source sample
2323
- [React Datta Dashboard](https://github.com/app-generator/react-datta-able-dashboard) - open-source sample
2424

25-
> API Methods - for full description please access [API Unified Definition](api-unified-definition.md)
25+
> API Methods - for full description please access [API Unified Definition](api-unified-definition.mdx)
2626
2727
- USERS API:
2828
- `/api/users/register`: create a new user

docs/boilerplate-code/boilerplate-jinja.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,7 @@ ASSETS_ROOT=/static/assets
230230

231231
## 👉 Static Assets for `production`
232232

233-
As explained in the [Static Assets](boilerplate-jinja.md#static-assets) section, the assets are managed via:
233+
As explained in the [Static Assets](boilerplate-jinja.mdx#static-assets) section, the assets are managed via:
234234

235235
- `apps/static/assets` - the folder where `JS`, `CSS`, and `images` files are saved
236236
- `ASSETS_ROOT` - environment variable, that defaults to `/static/assets` if not defined

docs/boilerplate-code/django-dashboard.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -466,7 +466,7 @@ INSTALLED_APPS = [
466466

467467
### 👉 Static Assets for `production`
468468

469-
As explained in the [Static Assets](django-dashboard.md#static-assets) section, the assets are managed via:
469+
As explained in the [Static Assets](django-dashboard.mdx#static-assets) section, the assets are managed via:
470470

471471
- `apps/static/assets` - the folder where `JS`, `CSS`, and `images` files are saved
472472
- `ASSETS_ROOT` - environment variable, that defaults to `/static/assets` if not defined

docs/boilerplate-code/django.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -464,7 +464,7 @@ INSTALLED_APPS = [
464464

465465
### 👉 Static Assets for `production`
466466

467-
As explained in the [Static Assets](django.md#static-assets) section, the assets are managed via:
467+
As explained in the [Static Assets](django.mdx#static-assets) section, the assets are managed via:
468468

469469
- `apps/static/assets` - the folder where `JS`, `CSS`, and `images` files are saved
470470
- `ASSETS_ROOT` - environment variable, that defaults to `/static/assets` if not defined

docs/boilerplate-code/flask-dashboard.mdx

Lines changed: 4 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,6 @@ To use the starter, [Python3](https://www.python.org) should be installed proper
2525
- Basic development tools (g++ compiler, python development libraries ..etc) used by Python to compile the app dependencies in your environment.
2626
- (Optional) `Docker` - a popular virtualization software
2727

28-
\
29-
3028
## ✨ Start the app in Docker
3129

3230
> 👉 **Step 1** - Download the code from the GH repository (using `GIT`)
@@ -45,8 +43,6 @@ $ docker-compose up --build
4543

4644
Visit `http://localhost:5085` in your browser. The app should be up & running.
4745

48-
\
49-
5046
## ✨ Manual Build
5147

5248
> Download the code
@@ -57,8 +53,6 @@ $ git clone https://github.com/app-generator/boilerplate-code-flask-dashboard.gi
5753
$ cd boilerplate-code-flask-dashboard
5854
```
5955

60-
\
61-
6256
### 👉 Set Up for `Unix`, `MacOS`
6357

6458
> Install modules via `VENV`
@@ -84,8 +78,6 @@ $ flask run
8478

8579
At this point, the app runs at `http://127.0.0.1:5000/`.
8680

87-
\
88-
8981
### 👉 Set Up for `Windows`
9082

9183
> Install modules via `VENV` (windows)
@@ -116,8 +108,6 @@ $ flask run
116108

117109
At this point, the app runs at `http://127.0.0.1:5000/`.
118110

119-
\
120-
121111
## ✨ Manage App `Users`
122112

123113
By default, the starter is not provided with users.
@@ -183,28 +173,27 @@ The project is coded using a simple and intuitive structure presented below:
183173
|-- ************************************************************************
184174
```
185175

186-
\
187-
188176
## ✨ Application Bootstrap Flow
189177

190178
The entry point of the project is the `run.py` file where the project configuration is bundled. The `most important files` that make the project functional are listed below:
191179

192180
- `run.py` is the application entry point
181+
193182
- read the `Debug` flag from `.env`
194183
- import the `db` object from `apps` packag
195184

196185
e
186+
197187
- import the `create_app` helper from `apps
198188
199189
`
190+
200191
- `Flask` application is built by `create_app`
201192
- If `Debug=True` - SQLite is used (development mode)
202193
- If `Debug=False` - SQLite is used (production mode)
203194
- Configuration
204195
- is defined in `apps/config.py`
205196

206-
\
207-
208197
## ✨ How the `Flask App` object is constructed
209198

210199
The file that constructs the core features of our application is `apps/__init__.py`. The most important steps are listed below:
@@ -223,8 +212,6 @@ The file that constructs the core features of our application is `apps/__init__.
223212
- initialize the database
224213
- `db.create_all()` - create all tables
225214

226-
\
227-
228215
## ✨ Application Blueprints
229216

230217
The codebase is built using a modular design that uses `blueprints`. By default, the project comes with a two `blueprints`
@@ -246,8 +233,6 @@ The codebase is built using a modular design that uses `blueprints`. By default,
246233

247234
This module returns all pages saved in the `templates/home` directory to authenticated users. In case a page is not found, a generic page is returned using a `404` HTTP error status.
248235

249-
\
250-
251236
## ✨ UI Assets and Templates
252237

253238
The project comes with a modern UI fully migrated and usable with Django Template Engine.
@@ -293,8 +278,6 @@ All pages and components are saved inside the `apps/templates` directory. Here a
293278
|-- ************************************************************************
294279
```
295280

296-
\
297-
298281
### 👉 Static Assets
299282

300283
The static assets used by the project (`JS`, `CSS`, `images`) are saved inside the `apps/static/assets` folder. This path can be customized with ease via `ASSETS_ROOT` variable saved in the `.env` file.
@@ -329,8 +312,6 @@ At runtime, the `href` property is resolved to `/static/assets/css/style.css` ba
329312
ASSETS_ROOT=/static/assets
330313
```
331314

332-
\
333-
334315
## ✨ Customisation
335316

336317
### 👉 Set up the MySql Database
@@ -357,8 +338,6 @@ $ pip install flask_mysqldb
357338
- `DB_USERNAME`: default value = `appseed_db_usr`
358339
- `DB_PASS` : default value = `pass`
359340

360-
\
361-
362341
Here is a sample:
363342

364343
```
@@ -376,11 +355,9 @@ DB_PORT=3306 # MySql port, default = 3306
376355

377356
At this point, the app should use `MySql` for the persistence layer.
378357

379-
\
380-
381358
### 👉 Static Assets for `production`
382359

383-
As explained in the [Static Assets](flask-dashboard.md#static-assets) section, the assets are managed via:
360+
As explained in the [Static Assets](flask-dashboard.mdx#static-assets) section, the assets are managed via:
384361

385362
- `apps/static/assets` - the folder where `JS`, `CSS`, and `images` files are saved
386363
- `ASSETS_ROOT` - environment variable, that defaults to `/static/assets` if not defined

docs/boilerplate-code/flask.mdx

Lines changed: 4 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,6 @@ To use the starter, [Python3](https://www.python.org) should be installed proper
2222
- Basic development tools (g++ compiler, python development libraries ..etc) used by Python to compile the app dependencies in your environment.
2323
- (Optional) `Docker` - a popular virtualization software
2424

25-
\
26-
2725
## ✨ Start the app in Docker
2826

2927
> 👉 **Step 1** - Download the code from the GH repository (using `GIT`)
@@ -42,8 +40,6 @@ $ docker-compose up --build
4240

4341
Visit `http://localhost:5085` in your browser. The app should be up & running.
4442

45-
\
46-
4743
## ✨ Manual Build
4844

4945
> Download the code
@@ -54,8 +50,6 @@ $ git clone https://github.com/app-generator/boilerplate-code-flask.git
5450
$ cd boilerplate-code-flask
5551
```
5652

57-
\
58-
5953
### 👉 Set Up for `Unix`, `MacOS`
6054

6155
> Install modules via `VENV`
@@ -81,8 +75,6 @@ $ flask run
8175

8276
At this point, the app runs at `http://127.0.0.1:5000/`.
8377

84-
\
85-
8678
### 👉 Set Up for `Windows`
8779

8880
> Install modules via `VENV` (windows)
@@ -113,8 +105,6 @@ $ flask run
113105

114106
At this point, the app runs at `http://127.0.0.1:5000/`.
115107

116-
\
117-
118108
## ✨ Manage App `Users`
119109

120110
By default, the starter is not provided with users.
@@ -179,28 +169,27 @@ The project is coded using a simple and intuitive structure presented below:
179169
|-- ************************************************************************
180170
```
181171

182-
\
183-
184172
## ✨ Application Bootstrap Flow
185173

186174
The entry point of the project is the `run.py` file where the project configuration is bundled. The `most important files` that make the project functional are listed below:
187175

188176
- `run.py` is the application entry point
177+
189178
- read the `Debug` flag from `.env`
190179
- import the `db` object from `apps` packag
191180

192181
e
182+
193183
- import the `create_app` helper from `apps
194184
195185
`
186+
196187
- `Flask` application is built by `create_app`
197188
- If `Debug=True` - SQLite is used (development mode)
198189
- If `Debug=False` - SQLite is used (production mode)
199190
- Configuration
200191
- is defined in `apps/config.py`
201192

202-
\
203-
204193
## ✨ How the `Flask App` object is constructed
205194

206195
The file that constructs the core features of our application is `apps/__init__.py`. The most important steps are listed below:
@@ -219,8 +208,6 @@ The file that constructs the core features of our application is `apps/__init__.
219208
- initialize the database
220209
- `db.create_all()` - create all tables
221210

222-
\
223-
224211
## ✨ Application Blueprints
225212

226213
The codebase is built using a modular design that uses `blueprints`. By default, the project comes with a two `blueprints`
@@ -242,8 +229,6 @@ The codebase is built using a modular design that uses `blueprints`. By default,
242229

243230
This module returns all pages saved in the `templates/home` directory to authenticated users. In case a page is not found, a generic page is returned using a `404` HTTP error status.
244231

245-
\
246-
247232
## ✨ UI Assets and Templates
248233

249234
The project comes with a modern UI fully migrated and usable with Django Template Engine.
@@ -289,8 +274,6 @@ All pages and components are saved inside the `apps/templates` directory. Here a
289274
|-- ************************************************************************
290275
```
291276

292-
\
293-
294277
### 👉 Static Assets
295278

296279
The static assets used by the project (`JS`, `CSS`, `images`) are saved inside the `apps/static/assets` folder. This path can be customized with ease via `ASSETS_ROOT` variable saved in the `.env` file.
@@ -325,8 +308,6 @@ At runtime, the `href` property is resolved to `/static/assets/css/style.css` ba
325308
ASSETS_ROOT=/static/assets
326309
```
327310

328-
\
329-
330311
## ✨ Customisation
331312

332313
### 👉 Set up the MySql Database
@@ -353,8 +334,6 @@ $ pip install flask_mysqldb
353334
- `DB_USERNAME`: default value = `appseed_db_usr`
354335
- `DB_PASS` : default value = `pass`
355336

356-
\
357-
358337
Here is a sample:
359338

360339
```
@@ -372,11 +351,9 @@ DB_PORT=3306 # MySql port, default = 3306
372351

373352
At this point, the app should use `MySql` for the persistence layer.
374353

375-
\
376-
377354
### 👉 Static Assets for `production`
378355

379-
As explained in the [Static Assets](flask.md#static-assets) section, the assets are managed via:
356+
As explained in the [Static Assets](flask.mdx#static-assets) section, the assets are managed via:
380357

381358
- `apps/static/assets` - the folder where `JS`, `CSS`, and `images` files are saved
382359
- `ASSETS_ROOT` - environment variable, that defaults to `/static/assets` if not defined

docs/content/bootstrap-template/adminator.mdx

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,6 @@ For newcomers, [Adminator](https://appseed.us/admin-dashboards/django-dashboard-
1818

1919
## How to compile the project
2020

21-
To use this modern design and compile in a local environment a [minimal development](../tutorials/minimal-programming-kit.md) kit is required:
22-
2321
- A modern editor - [VSCode](https://code.visualstudio.com/)
2422
- [Nodejs](https://nodejs.org/en/) - used in [Javascript](https://developer.mozilla.org/en-US/docs/Web/JavaScript)-based products and tools 
2523
- [GIT](https://git-scm.com/) - a command-line tool used to download sources from [Github](https://github.com/)

0 commit comments

Comments
 (0)