Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

readme typo fixed #28

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 45 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Angular 16 / Bootstrap 5 & CRUD REST API
# Angular 16 / Bootstrap 5 & CRUD REST API

<table>
<tr>
Expand All @@ -10,21 +10,26 @@

it's a repo designed to create a **Web Application with Angular 16**

* Frontend - [**Angular 16.1.2**](https://github.com/angular/angular/releases) & [**Angular CLI 16.1.1
**](https://github.com/angular/angular-cli/releases/)


* Frontend - [**Angular 16.1.3**](https://github.com/angular/angular/releases) & [**Angular CLI 16.1.3**](https://github.com/angular/angular-cli/releases/)

* UI prototype - [**bootstrap 5**](https://v5.getbootstrap.com/docs/5.0/getting-started/download/)

* Backend - CRUD REST API [**PostgreSQL**](https://www.postgresql.org/download/)

* See the [**Live demo**](#live-demo), Test the repo with [**Quick start**](#quick-start) and for more information Read the step by step [**Tutorial**](#tutorial) or read the [**Getting started**](#getting-started)
* Backend - CRUD REST API [**PostgreSQL**](https://www.postgresql.org/download/)

* See the [**Live demo**](#live-demo), Test the repo with [**Quick start**](#quick-start) and for more information Read
the step by step [**Tutorial**](#tutorial) or read the [**Getting started**](#getting-started)

</td>
</tr>
</table>

# [Live Demo](#live-demo)

Here is a working live demo : https://angular.ganatan.com/


Expand All @@ -35,10 +40,6 @@ Here is a working live demo : https://angular.ganatan.com/
Application"/>
</a>
</p>
</p>




# Lighthouse Audit

Expand All @@ -48,8 +49,6 @@ Here is a working live demo : https://angular.ganatan.com/
<img src="./img/search-engine-optimization-avec-angular-lighthouse-after.png" alt="Ganatan Lighthouse SEO Angular Example Demo"/>
</a>
</p>
</p>


## Table of contents

Expand All @@ -61,14 +60,17 @@ Here is a working live demo : https://angular.ganatan.com/
- [Documentation](#documentation)

### Front-end : What's included

> Dependencies

- [x] Angular : 16.1.3
- [x] Angular CLI : 16.1.3
- [x] Angular Universal : 16.1.1
- [x] Bootstrap : 5.3.0
- [x] Fontawesome : 6.4.0

> Features

- [x] Routing
- [x] Lazy Loading
- [x] Server Side Rendering
Expand Down Expand Up @@ -103,45 +105,51 @@ npm install
npm start

```
in your browser go to [http://localhost:4200](http://localhost:4200)

in your browser go to [http://localhost:4200](http://localhost:4200)

## Front-end

### Installation

* `npm install` (installing dependencies)
* `npm outdated` (verifying dependencies)

### Developpement
### Development

* `npm run start`
* in your browser [http://localhost:4200](http://localhost:4200)
* in your browser [http://localhost:4200](http://localhost:4200)

## Linter

* `npm run lint`

## Tests

* `npm run test`
* `npm run coverage`

### Compilation

* `npm run build` ( without SSR)
* `npm run build:ssr` ( with SSR)

### Production

* `npm run serve:ssr`
* in your browser [http://localhost:4000](http://localhost:4000)
* in your browser [http://localhost:4000](http://localhost:4000)

### Bootstrap UI

* `change directory` cd ui
* Launch html pages in your browser



## Back-end

### Back-end : What's included

> Tools

- [x] mysql-express-batch (with Node.js)
- [x] mysql-sql (with SQL Scripts)

Expand All @@ -150,37 +158,40 @@ in your browser go to [http://localhost:4200](http://localhost:4200)
- [x] postgresql-sql (with SQL Scripts)

> Features

- [x] Database Creation
- [x] Domains Creation (only PostgreSQL)
- [x] Tables Creation
- [x] Importing Data
- [x] Exporting Data
- [x] Serving RESTful CRUD API
- [x] Serving RESTful CRUD API

## Database Creation with PostgreSQL

## Database Creation with PostgreSQL
> Use the SQL scripts in postgresql-sql

- [x] create-database.sql
- [x] create-domains.sql
- [x] create-tables.sql
- [x] insert-data.sql

## Database Creation with MySQL

> Use the SQL scripts in mysql-sql

- [x] create-database.sql
- [x] create-tables.sql
- [x] insert-data.sql


## Database Creation with Node.js and PostgreSQL

## PostgreSQL Password

* Change settings in postgresql-express-batch/app/config
* File config/config.json
* dbUser: "postgres"
* dbUser: "postgres"
* dbPassword: "Trustno1" ! Change the Fox Mulder password by your password


```bash

# select the repo
Expand All @@ -199,15 +210,16 @@ npm run export
# Check the new files (for example movies.json)

```

## Database Creation with Node.js and MySQL

## MySQL Password

* Change settings in mysql-express-batch/app/config
* File config/config.json
* dbUser: "root"
* dbUser: "root"
* dbPassword: "Trustno1" ! Change the Fox Mulder password by your password


```bash

# select the repo
Expand All @@ -227,10 +239,10 @@ npm run export

```


## Serving CRUD REST API with Node.js & Express & PostgreSQL

## PostgreSQL Password

* Change settings in postgresql-express-crud/app/config
* File config/config.json
* dbUser: "postgres"
Expand Down Expand Up @@ -260,18 +272,23 @@ pm2 start process.config.js --env prod
```

### Tests API & PostgreSQL
* in your browser [http://localhost:5004/movies](http://localhost:5004/movies)
* in your browser [http://localhost:5004/shows](http://localhost:5004/shows)
* in your browser [http://localhost:5004/continents](http://localhost:5004/continents)
* in your browser [http://localhost:5004/countries](http://localhost:5004/countries)
* in your browser [http://localhost:5004/cities](http://localhost:5004/cities)

* in your browser [http://localhost:5004/movies](http://localhost:5004/movies)
* in your browser [http://localhost:5004/shows](http://localhost:5004/shows)
* in your browser [http://localhost:5004/continents](http://localhost:5004/continents)
* in your browser [http://localhost:5004/countries](http://localhost:5004/countries)
* in your browser [http://localhost:5004/cities](http://localhost:5004/cities)

### Author

* Author : danny

## Documentation

English Tutorials

- Step by Step - https://www.ganatan.com/tutorials/en

Tutoriels en français

- Etapes par étapes - https://www.ganatan.com/tutorials