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

Added Introduction section on read the docs #393

Merged
merged 2 commits into from
Sep 27, 2020
Merged
Show file tree
Hide file tree
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
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# generator-jhipster-dotnetcore
[![NPM version][npm-image]][npm-url]
[![Documentation Status](https://readthedocs.org/projects/jhipsternet/badge/?version=latest)](https://jhipsternet.readthedocs.io/en/latest/?badge=latest)
[![Generator Build Status][github-actions-generator-image]][github-actions-url]
[![Integration JWT Build Status][github-actions-integ-jwt-image]][github-actions-url]
[![Integration OAUTH Build Status][github-actions-integ-oauth-image]][github-actions-url]
Expand All @@ -10,7 +11,11 @@
[![Sonar Cloud Maintainability Rate][sonar-maintainability-image]][sonar-url]
[![Sonar Cloud Duplicated Code][sonar-duplication-image]][sonar-url]

> JHipster blueprint,
> JHipster blueprint

Documentation and information about `JHipster.NET ` is available [here](https://jhipsternet.readthedocs.io/en/latest/)

Full documentation and information about JHipster is available [here](https://www.jhipster.tech/)

# Analysis of the sample project
https://github.com/jhipster/jhipster-sample-app-dotnetcore
Expand Down
10 changes: 10 additions & 0 deletions docs/Introduction/big-picture.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
## Big Picture

JHipster is a well-known platform for generating modern application in java world.
JHipster provides a blueprints system that allows to override the default behavior of the generator

JHipster.NET is a blueprint that overrides the back-end part, originally generated in spring boot, by back-end in asp.net core. For the front-end all the common language can be used (angular, react).

In alpha version we have also the possibility to choose Blazor for the front. [Blazor as front issue](https://github.com/jhipster/jhipster-dotnetcore/issues/165)

This blueprint it's an official blueprint of jhipster [official-blueprints](https://www.jhipster.tech/modules/official-blueprints/)
53 changes: 53 additions & 0 deletions docs/Introduction/getting-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
## Getting Started

### Prerequisites

As this is a [JHipster](https://www.jhipster.tech/) blueprint, we expect you have JHipster and its related tools already installed:

- [Installing JHipster](https://www.jhipster.tech/installation/)

### Generate your first application

Installation of the blueprint

```bash
npm install -g generator-jhipster-dotnetcore
```

Call the generator

```bash
jhipster --blueprints dotnetcore
```

After running this command you have few questions to answer, as Application name, authentication mode, client framework etc
Once it's done, you can build and run your application.

```bash
dotnet run --verbosity normal --project ./src/YourAppName/YourAppName.csproj
```

Your first application is ready and you can now use it with default user like JHipster (admin admin or user user)

Ok now you have an application but without entity.
JHipster allow you to add entity with cli or with jdl file (add link)
JHipster.NET have the same behavior.

```bash
jhipster entity <entity-name>
```

Or with jdl

```bash
jhipster import-jdl my_file.jdl
```
You can edit jdl with https://start.jhipster.tech/jdl-studio/

You have now an application with CRUD operations on each new entities with potentially link between entities (one-to-one, many-to-one or many-to-many)

Default configurations are availables in the generated project. As an example, a docker compose file is generated with monitoring solutions (influxdb telegraf and chronograf or grafana)

The repository : [https://github.com/jhipster/jhipster-dotnetcore](https://github.com/jhipster/jhipster-dotnetcore)

Sample project : [https://github.com/jhipster/jhipster-sample-app-dotnetcore](https://github.com/jhipster/jhipster-sample-app-dotnetcore)
1 change: 1 addition & 0 deletions docs/autobuild.bat
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
sphinx-autobuild.exe . .\_build\html\
Loading