(Coloque uma imagem que represente o seu Projeto)
(Insert an image that represents your Project)

About • Features • Revised Concepts • Installation • Get Started • Technologies • License

(Coloque aqui as Funcionalidades do seu Projeto)
(Place the Features of your project here)

• Creation, Editing and Deletion of Posts, Themes and User.
• Admin Roles

(Você pode colocar alguns conceitos usados no seu Projeto que esteja revisando ou que acha importante destacar)
(You can put some concepts used in your Project that you are reviewing or that you think is important to highlight)

• Angular Componentization
• Use of Routes
• API consumption
• Posts, Themes and User CRUD
• Custom Alerts, Sorting, Searching and Admin Role
• Control of Logged Users
• Documentation with Compodoc

(Explique como uma pessoa desenvolvedora pode estar fazendo a instalação do seu Projeto em outra máquina. Aqui cabe a você, e também as especificações do seu projeto, como explicar a forma de instalação)

(Explain how another developer might be installing your Project on their machine. Here it's up to you, and also the specifications of your project, how to explain how to install it)

You must have already installed

• Node.js
• Npm or Yarn
• Angular
• MySQL

Recommendations

• It is recommended that you have installed Google Chrome or Edge
• I recommend using VSCode as development IDE

Let's divide it into 3 steps.

1. Clone this repository
2. Install dependencies
3. Initializing the BackEnd

git clone Link of the your Repository 

npm install

or

yarn

Make sure your internet is stable, as this may take a while

If you have a BackEnd local, start it before the Angular Project

If you have a Hosted BackEnd, you'll need configure the Routes and Models of Angular Project with your BackEnd

(Após a instalação, aqui você explica como outra pessoa desenvolvedora pode estar iniciando o seu Projeto. Aqui cabe a você, e também as especificações do seu projeto, como explicar a forma de inicialização)

(After installation, here you explain how another developer can be starting your Project. Here it's up to you, and also the specifications of your project, how to explain how to start)

1. Run the backend or configure as explained above

2. Run the project

ng serve

3. Now, open your browser and navigate to: http://localhost:4200

(Liste as tecnologias usadas no seu Projeto)
(List the technologies used in your Project)

• AngularJS
• TypeScript

(Escreva algumas informações sobre a Licença do seu Projeto, e por quem foi feito. Recomendo colocar um link para a Licença do projeto e no seu nome coloque o link da sua rede social profisional: Linkedin, Behance, Site Pessoal, etc.)

(Write some information about your Project License, and by whom it was made. I recommend putting a link to the Project License and in your name put the link to your professional social network: Linkedin, Behance, Personal Site, etc.)

Released in 2021.

This project is under the MIT license.

Made with love by Yuri Oliveira 🚀.

Vou deixar alguns links que podem ser úteis para você criar os ReadMes dos seus projetos:
I'll leave some links that might be useful for you to create the ReadMes of your projects:

• Shields.io | Para criar as Badges / To create the Badges
• StackEdit | Para ajudar a criar os ReadMe / To help create the ReadMe
• Basic Syntax | Markdown Guide | Guia de Markdown / Markdown Guide