Skip to content

Commit

Permalink
chore: update README for .NET version and improve grammar and punctua…
Browse files Browse the repository at this point in the history
…tion
  • Loading branch information
antosubash committed Nov 9, 2024
1 parent bcfe84c commit 81247d2
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,38 +4,38 @@ This project can be used as a drop-in replacement for the Angular UI of the ABP

## Demo

You can see a demo of the app [here](https://abpreact.antosubash.com/)
You can see a demo of the app [here](https://abpreact.antosubash.com/).

## Getting Started

### Documentation

You can find the documentation [here](https://antosubash.github.io/AbpReact/)
You can find the documentation [here](https://antosubash.github.io/AbpReact/).

### Prerequisites

- [Node.js](https://nodejs.org/en/)
- [pnpm](https://pnpm.js.org/en/installation)
- [ABP Framework](https://abp.io/)
- [.Net 7](https://dotnet.microsoft.com/download/dotnet/7.0)
- [.NET 8](https://dotnet.microsoft.com/download/dotnet/8.0)

### Installing Template

Install the ABP React .Net Template
Install the ABP React .NET Template:

```bash
dotnet new install Anto.Abp.React.Template
```

### Creating a new project

Create a new project using the template
Create a new project using the template:

```bash
dotnet new abp-react -o my-project-name --apiUrl abp.antosubash.com
```

> Note: You can use any name for the project. I used `my-project-name` for this example. keep in mind that the project name should be in kebab case (all lowercase and words separated by hyphens) because it will be used as the name of the packages org name.
> Note: You can use any name for the project. I used `my-project-name` for this example. Keep in mind that the project name should be in kebab case (all lowercase and words separated by hyphens) because it will be used as the name of the packages org name.
### Update the Environment Variables

Expand All @@ -51,17 +51,17 @@ pnpm dev

## What is this?

This is a React UI for the [ABP Framework](https://abp.io/). We are working on a beta release and it is officially not ready for production, However, you can use it with your own risk. It uses [AbpTemplate](https://github.com/antosubash/AbpTemplate) as the backend. It is built using [Next.js](https://nextjs.org/), [TypeScript](https://www.typescriptlang.org/) and [Tailwind CSS](https://tailwindcss.com/).
This is a React UI for the [ABP Framework](https://abp.io/). We are working on a beta release and it is officially not ready for production. However, you can use it at your own risk. It uses [AbpTemplate](https://github.com/antosubash/AbpTemplate) as the backend. It is built using [Next.js](https://nextjs.org/), [TypeScript](https://www.typescriptlang.org/), and [Tailwind CSS](https://tailwindcss.com/).

## Why Use ABP React?

The main reason is React and Next.js. In the modern web you need a framework which can build a fast and SEO friendly website. React and Next.js are the best options for that. You can build a static, SSR and CSR website with Next.js. It is also very easy to integrate with ABP Framework.
The main reason is React and Next.js. In the modern web, you need a framework that can build a fast and SEO-friendly website. React and Next.js are the best options for that. You can build a static, SSR, and CSR website with Next.js. It is also very easy to integrate with the ABP Framework.

## LightHouse Score

![Lighthouse Score](/images/lighthosescore.png)

The score is for the landing page. other pages are not yet checked for with lighthouse. you can check the score for the landing page [here](https://pagespeed.web.dev/report?url=https%3A%2F%2Fabpreact.antosubash.com%2F&form_factor=desktop).
The score is for the landing page. Other pages are not yet checked with Lighthouse. You can check the score for the landing page [here](https://pagespeed.web.dev/report?url=https%3A%2F%2Fabpreact.antosubash.com%2F&form_factor=desktop).

## Goals

Expand All @@ -86,7 +86,7 @@ Most of the features are implemented. We are planning to keep it similar to the

## Support

If want to build your project with ABP React and need support, you can contact me at [[email protected]](mailto:[email protected])
If you want to build your project with ABP React and need support, you can contact me at [[email protected]](mailto:[email protected]).

## How to run

Expand All @@ -104,7 +104,7 @@ If want to build your project with ABP React and need support, you can contact m

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Acknowledgments

Expand Down

0 comments on commit 81247d2

Please sign in to comment.