From 3573a199d9d3f1522449b4b4287261c7763597e8 Mon Sep 17 00:00:00 2001 From: Mahmut Gundogdu Date: Mon, 9 May 2022 13:31:56 +0300 Subject: [PATCH 1/3] add `How to contribute to abp.io as a frontend developer` docs --- ...ntribute-abp.io-as-a-frontend-developer.md | 46 +++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 docs/en/Contribution/How-to-Contribute-abp.io-as-a-frontend-developer.md diff --git a/docs/en/Contribution/How-to-Contribute-abp.io-as-a-frontend-developer.md b/docs/en/Contribution/How-to-Contribute-abp.io-as-a-frontend-developer.md new file mode 100644 index 0000000000..af2a4c6ff3 --- /dev/null +++ b/docs/en/Contribution/How-to-Contribute-abp.io-as-a-frontend-developer.md @@ -0,0 +1,46 @@ +# How to contribute to abp.io as a frontend developer + +## How to setup development environment + +### Pre-requirements + +- Dotnet core SDK https://dotnet.microsoft.com/en-us/download +- Nodejs LTS https://nodejs.org/en/ +- Docker https://docs.docker.com/engine/install +- Angular CLI. https://angular.io/guide/what-is-angular#angular-cli +- Abp CLI https://docs.abp.io/en/abp/latest/cli +- A code editor + +### Sample docker commands + +You need to install SQL Server and Redis. You can install these programs without docker, but my example uses docker containers. Your computer should have Docker Engine. Then open the terminal en execute the commands one by one. +For the Sql Server + +docker run -v sqlvolume:/var/opt/mssql -e 'ACCEPT_EULA=Y' -e 'SA_PASSWORD=yourpassword -p 1433:1433 -d mcr.microsoft.com/mssql/server:2019-CU3-ubuntu-18.04 + +For the Redis + +docker run -p 6379:6379 -d redis + +Then we are ready to download and execute the code. + +## Folder Structure + +The app has a backend written in .net core (c#) and an angular app. It would help if you ran both of them. + +### Running Backend App + +The path of the Backend app is “templates\app\aspnet-core.” If you want to work with dockerized SQL Server, you should change connection strings for running with docker. The path of the connection string is +`templates\app\aspnet-core\src\MyCompanyName.MyProjectName.DbMigrator\appsettings.json`. + +Before running the backend, you should run the Db migrator project. The DbMigrator created initial tables and values. The path of DbMigrator is `templates\app\aspnet-core\src\MyCompanyName.MyProjectName.DbMigrator`. Open a terminal in the path and execute the command `dotnet run` in terminal + +Next step you should go to path of backend host project. The path is `templates\app\aspnet-core\src\MyCompanyName.MyProjectName.HttpApi.HostWithIds`. Open a terminal in the path and execute the command `dotnet run` in terminal + +Your backend should be running successfully + +### Running Frontend App + +There is a demo app. The path of the demo app is `npm\ng-packs\apps\dev-app`. The demo app is connected to the packages with local references. Open the terminal in `npm\ng-packs\apps\dev-app` and execute `yarn` or `npm i` in terminal. After the package installed run `npm start` or `yarn start`. + +The repo uses Nx and packages connected with `local references`. The packages path is `”npm\ng-packs\packages` From 1fbc4bc3f91642acc1778689eda0fe56a1231d84 Mon Sep 17 00:00:00 2001 From: Mahmut Gundogdu Date: Tue, 10 May 2022 18:05:33 +0300 Subject: [PATCH 2/3] Add abp install-libs steps to docs --- .../How-to-Contribute-abp.io-as-a-frontend-developer.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/en/Contribution/How-to-Contribute-abp.io-as-a-frontend-developer.md b/docs/en/Contribution/How-to-Contribute-abp.io-as-a-frontend-developer.md index af2a4c6ff3..be81162642 100644 --- a/docs/en/Contribution/How-to-Contribute-abp.io-as-a-frontend-developer.md +++ b/docs/en/Contribution/How-to-Contribute-abp.io-as-a-frontend-developer.md @@ -35,6 +35,8 @@ The path of the Backend app is “templates\app\aspnet-core.” If you want to w Before running the backend, you should run the Db migrator project. The DbMigrator created initial tables and values. The path of DbMigrator is `templates\app\aspnet-core\src\MyCompanyName.MyProjectName.DbMigrator`. Open a terminal in the path and execute the command `dotnet run` in terminal +One last step before the running the backend is installing client-side libraries. Go to `templates\app\aspnet-core`. Open a terminal in the path and execute the command `abp install-libs` in terminal + Next step you should go to path of backend host project. The path is `templates\app\aspnet-core\src\MyCompanyName.MyProjectName.HttpApi.HostWithIds`. Open a terminal in the path and execute the command `dotnet run` in terminal Your backend should be running successfully From 2c031a38ded932b57e2f223b8aa8e0174f0e4f5c Mon Sep 17 00:00:00 2001 From: Mahmut Gundogdu Date: Tue, 10 May 2022 19:48:07 +0300 Subject: [PATCH 3/3] add `How to contribute to abp.io as a frontend developer` docs --- .../How-to-Contribute-abp.io-as-a-frontend-developer.md | 6 ++++++ docs/en/Contribution/Index.md | 4 ++++ 2 files changed, 10 insertions(+) diff --git a/docs/en/Contribution/How-to-Contribute-abp.io-as-a-frontend-developer.md b/docs/en/Contribution/How-to-Contribute-abp.io-as-a-frontend-developer.md index be81162642..2d9cd64065 100644 --- a/docs/en/Contribution/How-to-Contribute-abp.io-as-a-frontend-developer.md +++ b/docs/en/Contribution/How-to-Contribute-abp.io-as-a-frontend-developer.md @@ -11,6 +11,12 @@ - Abp CLI https://docs.abp.io/en/abp/latest/cli - A code editor +Note: This arcticle prepare Windows OS. You may change the path type of your OS. an Example + +Windows: `templates\app\aspnet-core\src\MyCompanyName.MyProjectName.DbMigrator\appsettings.json` + +Unix: `templates/app/aspnet-core/src/MyCompanyName.MyProjectName.DbMigrator/appsettings.json` + ### Sample docker commands You need to install SQL Server and Redis. You can install these programs without docker, but my example uses docker containers. Your computer should have Docker Engine. Then open the terminal en execute the commands one by one. diff --git a/docs/en/Contribution/Index.md b/docs/en/Contribution/Index.md index d2525ae191..6160aa3273 100644 --- a/docs/en/Contribution/Index.md +++ b/docs/en/Contribution/Index.md @@ -70,3 +70,7 @@ If you want to make a change on a specific resource file, you can find the file ## Bug Report If you find any bug, please [create an issue on the Github repository](https://github.com/abpframework/abp/issues/new). + +## Setup Frontend Development Environment + +[How to contribute to abp.io as a frontend developer](How-to-Contribute-abp.io-as-a-frontend-developer.md)