Skip to content

Commit 06ad2d2

Browse files
fabiobrasileiroofabiobrasileiroo
authored
Update README.md
1 parent 24387a3 commit 06ad2d2

1 file changed

Lines changed: 218 additions & 66 deletions

File tree

‎README.md‎

Lines changed: 218 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
<img width=100% src="https://capsule-render.vercel.app/api?type=waving&color=4169e1&height=120&section=header"/>
1+
<img width=100% src="https://capsule-render.vercel.app/api?type=waving&color=54D300&height=120&section=header"/>
22

3-
[![Open Source Love](https://firstcontributions.github.io/open-source-badges/badges/open-source-v1/open-source.svg)](https://github.com/firstcontributions/open-source-badges)
3+
[![Software Livre](https://firstcontributions.github.io/open-source-badges/badges/open-source-v1/open-source.svg)](https://github.com/firstcontributions/open-source-badges)
44
[<img align="right" width="150" src="https://firstcontributions.github.io/assets/Readme/join-slack-team.png">](https://join.slack.com/t/firstcontributors/shared_invite/zt-1n4y7xnk0-DnLVTaN6U9xLU79H5Hi62w)
5-
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
6-
[![Open Source Helpers](https://www.codetriage.com/roshanjossey/first-contributions/badges/users.svg)](https://www.codetriage.com/roshanjossey/first-contributions)
5+
[![License: GPL 3](https://img.shields.io/badge/license-GPLv3-blue)](https://www.gnu.org/licenses/gpl-3.0.pt-br.html)
6+
[![Software Livre Helpers](https://www.codetriage.com/roshanjossey/first-contributions/badges/users.svg)](https://www.codetriage.com/roshanjossey/first-contributions)
77

88
#### _Read this in [other languages](translations/Translations.md)._
99

@@ -84,72 +84,224 @@
8484
<kbd>[<img title="Ewe (TOGO)" alt="Ewe (TOGO)" src="https://cdn.statically.io/gh/hjnilsson/country-flags/master/svg/tg.svg" width="22">](translations/README.ewe.md)</kbd>
8585
<kbd>[<img title="አማርኛ" alt="አማርኛ" src="https://cdn.statically.io/gh/hjnilsson/country-flags/master/svg/et.svg" width="22">](translations/README.et.md)</kbd>
8686

87+
<h1 align="center">
88+
<a href="https://amplication.com/#gh-light-mode-only">
89+
<img src="./.github/assets/amplication-logo-light-mode.svg">
90+
</a>
91+
<a href="https://amplication.com/#gh-dark-mode-only">
92+
<img src="./.github/assets/amplication-logo-dark-mode.svg">
93+
</a>
94+
</h1>
8795

88-
[![Typing SVG](https://readme-typing-svg.herokuapp.com/?color=00ffdf&size=35&center=true&vCenter=true&width=1000&lines=HELLO,+My+name+is+Fabio+Brasileiro;I'm+from+Brazil,+Amazonas,+Manaus;I+Studying+software+engineering+;Be+Welcome!+:%29)](https://git.io/typing-svg)
89-
<div>
90-
<a href="https://github.com/fabiobrasileiroo">
91-
<div>
92-
<a href="https://www.youtube.com/@fabiobrasileiroo" target="_blank">
93-
<img src=https://img.shields.io/badge/youtube-FF0000.svg?&style=for-the-badge&logo=youtube&logoColor=white alt=github style="margin-bottom: 5px;" />
96+
<p align="center">
97+
<i align="center">Instantly generate production-ready Node.js backend apps 🚀</i>
98+
</p>
99+
100+
<h4 align="center">
101+
<a href="https://github.com/amplication/amplication/actions/workflows/ci.yml">
102+
<img src="https://img.shields.io/github/actions/workflow/status/amplication/amplication/ci.yml?branch=master&label=pipeline&style=flat-square" alt="continuous integration" style="height: 20px;">
103+
</a>
104+
<a href="https://github.com/amplication/amplication/graphs/contributors">
105+
<img src="https://img.shields.io/github/contributors-anon/amplication/amplication?color=yellow&style=flat-square" alt="contributors" style="height: 20px;">
106+
</a>
107+
<a href="https://opensource.org/licenses/Apache-2.0">
108+
<img src="https://img.shields.io/badge/apache%202.0-blue.svg?style=flat-square&label=license" alt="license" style="height: 20px;">
94109
</a>
95-
<a href="https://github.com/fabiobrasileiroo" target="_blank">
96-
<img src=https://img.shields.io/badge/github-%2324292e.svg?&style=for-the-badge&logo=github&logoColor=white alt=github style="margin-bottom: 5px;" />
110+
<br>
111+
<a href="https://amplication.com/discord">
112+
<img src="https://img.shields.io/badge/discord-7289da.svg?style=flat-square&logo=discord" alt="discord" style="height: 20px;">
97113
</a>
98-
<a href="https://linkedin.com/in/fabiobrasileiro" target="_blank">
99-
<img src=https://img.shields.io/badge/linkedin-%231E77B5.svg?&style=for-the-badge&logo=linkedin&logoColor=white alt=linkedin style="margin-bottom: 0px;" />
114+
<a href="https://twitter.com/amplication">
115+
<img src="https://img.shields.io/twitter/follow/amplication?style=social" alt="twitter" style="height: 20px;">
100116
</a>
101-
</div>
102-
<div align="center">
103-
<img align="center" height="180em" src="https://github-readme-stats.vercel.app/api/top-langs/?username=fabiobrasileiroo&layout=compact&langs_count=10&theme=react&bg_color=0d1117&hide_border=true&hide=css=true"/>
104-
<img align="center" height="180em" src="https://github-readme-stats-sigma-five.vercel.app/api?username=fabiobrasileiroo&show_icons=true&include_all_commits=true&count_private=true&theme=react&hide_border=true&bg_color=0d1117" />
105-
</div>
106-
107-
<div align="center">
108-
<img src="https://github-readme-streak-stats.herokuapp.com?user=fabiobrasileiroo&theme=react&hide_border=true&locale=pt_BR&card_width=500&background=0d1117" alt="My contributions" />
109-
</div>
110-
111-
</div >
112-
113-
<!--[![Ashutosh's github activity graph](https://github-readme-activity-graph.cyclic.app/graph?username=fabiobrasileiroo&bg_color=000000&color=2dbfd2&line=4118a0&point=2dbfd2&area=true&hide_border=true)](https://github.com/ashutosh00710/github-readme-activity-graph)-->
114-
<div align="center">
115-
<img src="./perfilGif.gif" />
116-
</div>
117-
118-
<div align="center">
119-
120-
### Main skills:
121-
![Gnu](https://img.shields.io/badge/Gnu-%23333?style=for-the-badge&logo=Gnu&logoColor=white)
122-
![Linux](https://img.shields.io/badge/Linux-FCC624?style=for-the-badge&logo=linux&logoColor=black)
123-
![Debian](https://img.shields.io/badge/Debian-A81D33?style=for-the-badge&logo=debian&logoColor=white)
124-
![Git](https://img.shields.io/badge/git-%23F05033.svg?style=for-the-badge&logo=git&logoColor=white)
125-
<br>
126-
![CSS](https://img.shields.io/badge/-CSS-0D1117?style=for-the-badge&logo=CSS3&logoColor=1572B6&labelColor=0D1117)&nbsp;
127-
![HTML5](https://img.shields.io/badge/HTMl-0D1117.svg?style=for-the-badge&logo=html5&logoColor=orange)&nbsp;
128-
![JavaScript](https://img.shields.io/badge/-JavaScript-0D1117?style=for-the-badge&logo=javascript&labelColor=0D1117)&nbsp;
129-
![Angular](https://img.shields.io/badge/Angular-0D1117?style=for-the-badge&logo=angular&logoColor=61DAFB)&nbsp;
130-
![TypeScript](https://img.shields.io/badge/-TypeScript-0D1117?style=for-the-badge&logo=TypeScript&labelColor=0D1117)&nbsp;
131-
![Bootstrap](https://img.shields.io/badge/-Bootstrap-0D1117?style=for-the-badge&logo=Bootstrap&labelColor=0D1117)&nbsp;
132-
<!--![Visual Studio Code](https://img.shields.io/badge/Visual%20Studio%20Code-0078d7.svg?style=for-the-badge&logo=visual-studio-code&logoColor=white)-->
133-
134-
135-
### Studying in this moment:
136-
![ReactNative](https://img.shields.io/badge/React_Native-0D1117?style=for-the-badge&logo=react&logoColor=61DAFB)&nbsp;
137-
![React](https://img.shields.io/badge/-React-0D1117?style=for-the-badge&logo=react&labelColor=0D1117)&nbsp;
138-
![Php](https://img.shields.io/badge/-Php-0D1117?style=for-the-badge&logo=php&labelColor=0D1117)&nbsp;
139-
![Wordpress](https://img.shields.io/badge/-Wordpress-0D1117?style=for-the-badge&logo=wordpress&labelColor=0D1117)&nbsp;
140-
<br>
141-
![Mysql](https://img.shields.io/badge/-Mysql-0D1117?style=for-the-badge&logo=mysql&labelColor=0D1117)&nbsp;
142-
![Aws](https://img.shields.io/badge/Amazon_AWS-232F3E?style=for-the-badge&logo=amazon-aws&logoColor=white)&nbsp;
143-
![Python](https://img.shields.io/badge/-Python-0D1117?style=for-the-badge&logo=Python&labelColor=0D1117)&nbsp;
144-
![C](https://img.shields.io/badge/-C-0D1117?style=for-the-badge&logo=C&labelColor=0D1117)&nbsp;
145-
</div>
146-
147-
<div align="center">
148-
<br><p align="centre"><b>Visitors Count</b></p>
149-
<p align="center"><img align="center" src="https://profile-counter.glitch.me/{fabiobrasileiroo}/count.svg" /></p>
150-
<br>
151-
</div>
152-
<div>
117+
<a href="https://www.youtube.com/c/Amplicationcom">
118+
<img src="https://img.shields.io/badge/youtube-d95652.svg?style=flat-square&logo=youtube" alt="youtube" style="height: 20px;">
119+
</a>
120+
</h4>
121+
122+
123+
124+
<p align="center">
125+
<img src="https://github.com/amplication/amplication/assets/73097785/c7ed2bbc-8954-46a1-a520-91a4711a9320.png" alt="dashboard"/>
126+
</p>
127+
128+
## Introduction
129+
130+
`Amplication` is a robust, open-source development platform designed to revolutionize the creation of scalable and secure Node.js applications. We eliminate repetitive coding tasks and deliver production-ready infrastructure code, meticulously tailored to your specifications and adhering to industry best practices.
131+
132+
Our user-friendly interface fosters seamless integration of APIs, data models, databases, authentication, and authorization. Built on a flexible, plugin-based architecture, Amplication allows effortless customization of the code and offers a diverse range of integrations.
133+
134+
With a strong focus on collaboration, Amplication streamlines team-oriented development, making it an ideal choice for groups of all sizes, from startups to large enterprises. Our platform enables you to concentrate on your business logic, while we handle the heavy lifting.
135+
136+
Experience the fastest way to develop Node.js applications with Amplication.
137+
138+
<details open>
139+
<summary>
140+
Features
141+
</summary> <br />
142+
143+
<p align="center">
144+
<img width="49%" src="https://github.com/amplication/amplication/assets/73097785/9908a54a-7d49-4dbb-8f5e-3e99b7cadf30.png" alt="apis"/>
145+
&nbsp;
146+
<img width="49%" src="https://github.com/amplication/amplication/assets/73097785/ff406403-27f7-42b5-9569-d011432f16e5.png" alt="data-models"/>
147+
</p>
148+
149+
<p align="center">
150+
<img width="49%" src="https://github.com/amplication/amplication/assets/73097785/62c8d533-8475-4290-abc8-c433c095e68a.png" alt="plugins"/>
151+
&nbsp;
152+
<img width="49%" src="https://github.com/amplication/amplication/assets/73097785/9c67a354-a06f-47d1-a118-ab89b775bf91.png" alt="microservices"/>
153+
</p>
154+
155+
<p align="center">
156+
<img width="49%" src="https://github.com/amplication/amplication/assets/73097785/a51e166b-07ec-4c80-99ed-8792a81c4064.png" alt="own-your-code"/>
157+
&nbsp;
158+
<img width="49%" src="https://github.com/amplication/amplication/assets/73097785/1cca9721-b8d6-425b-a1a9-d10d3cdcc9b8.png" alt="customize-code"/>
159+
</p>
160+
161+
</details>
162+
163+
## Usage
164+
165+
To get started with Amplication, the hosted version of the product can be used. You can get started immediately at [app.amplication.com](https://app.amplication.com). After the login page, you will be guided through creating your first service. The [website](https://amplication.com) provides an overview of the application, additional information on the product and guides can be found in the [docs](https://docs.amplication.com).
166+
167+
<details>
168+
<summary>
169+
Tutorials
170+
</summary> <br />
171+
172+
- [To-do application using Amplication and Angular](https://docs.amplication.com/tutorials/angular-todos)
173+
- [To-do application using Amplication and React](https://docs.amplication.com/tutorials/react-todos)
174+
</details>
175+
176+
## Development
177+
178+
Alternatively, instead of using the hosted version of the product, Amplication can be run locally for code generation purposes or contributions - if so, please refer to our [contributing](#contributing_anchor) section.
179+
180+
<details open>
181+
<summary>
182+
Pre-requisites
183+
</summary> <br />
184+
To be able to start development on Amplication, make sure that you have the following prerequisites installed:
185+
186+
###
187+
188+
- Node.js
189+
- Docker
190+
- Git
191+
</details>
192+
193+
<details open>
194+
<summary>
195+
Running Amplication
196+
</summary> <br />
197+
198+
> **Note**
199+
> It is also possible to start development with GitHub Codespaces, when navigating to `< > Code`, select `Codespaces` instead of `Local`. Click on either the `+`-sign or the `Create codespace on master`-button.
200+
201+
Amplication is using a monorepo architecture - powered by <a href="https://nx.dev">Nx Workspaces</a> - where multiple applications and libraries exist in a single repository. To setup a local development environment the following steps can be followed:
202+
203+
**BEFORE** you run the following steps make sure:
204+
1. You have typescript installed locally on you machine ```npm install -g typescript```
205+
2. You are using a supported node version (check `engines` `node` in the [package.json](./package.json))
206+
3. You are using a supported npm version (check `engines` `npm` in the [package.json](./package.json))
207+
4. You have `docker` installed and running on your machine
208+
209+
210+
1. Clone the repository and install dependencies:
211+
```shell
212+
git clone https://github.com/amplication/amplication.git && cd amplication && npm install
213+
```
214+
215+
2. Run the setup script, which takes care of installing dependencies, building packages, and setting up the workspace:
216+
```shell
217+
npm run setup:dev
218+
```
219+
220+
3. Option 1: Running the required infrastructure - view infrastructure component logs
221+
222+
223+
```shell
224+
npm run docker:dev
225+
```
226+
3. Option 2: Running the required infrastructure - run the infrastructure components in background
227+
```shell
228+
npm run docker:dev -- -d
229+
```
230+
231+
4. Apply database migrations
232+
```shell
233+
npm run db:migrate:deploy
234+
```
235+
236+
5. To start developing, run one or more of the applications available under `serve:[application]` scripts of the package.json.
237+
238+
```shell
239+
# running the server component
240+
npm run serve:server
241+
242+
# running the client component
243+
npm run serve:client
244+
245+
# running the data-service-generator component
246+
npm run serve:dsg
247+
248+
# running the git-sync-manager component
249+
npm run serve:git
250+
251+
# running the plugin-api component
252+
npm run serve:plugins
253+
```
254+
255+
> **Note**
256+
> In order to run the Amplication client properly, both the client and server need to be started by the `npm run serve:[application]` command, as well as an additional component for development on a specific component.
257+
258+
The development environment should now be set up. Additional information on the different application components can be found under packages/`[application]`/README.md file. Happy hacking! 👾
259+
</details>
260+
261+
## Resources
262+
263+
- **[Website](https://amplication.com)** overview of the product.
264+
- **[Docs](https://docs.amplication.com)** for comprehensive documentation.
265+
- **[Blog](https://amplication.com/blog)** for guides and technical comparisons.
266+
- **[Roadmap](https://amplication.com/#roadmap)** to see what features will be added in the future.
267+
- **[Discord](https://amplication.com/discord)** for support and discussions with the community and the team.
268+
- **[GitHub](https://github.com/amplication/amplication)** for source code, project board, issues, and pull requests.
269+
- **[Twitter](https://twitter.com/amplication)** for the latest updates on the product and published blogs.
270+
- **[YouTube](https://www.youtube.com/c/Amplicationcom)** for guides and technical talks.
271+
272+
<a name="contributing_anchor"></a>
273+
## Contributing
274+
275+
Amplication is an open-source project. We are committed to a fully transparent development process and highly appreciate any contributions. Whether you are helping us fix bugs, proposing new features, improving our documentation or spreading the word - we would love to have you as a part of the Amplication community. Please refer to our [contribution guidelines](./CONTRIBUTING.md) and [code of conduct](./CODE_OF_CONDUCT.md).
276+
277+
- Bug Report: If you see an error message or encounter an issue while using Amplication, please create a [bug report](https://github.com/amplication/amplication/issues/new?assignees=&labels=type%3A+bug&template=bug.yaml&title=%F0%9F%90%9B+Bug+Report%3A+).
278+
279+
- Feature Request: If you have an idea or if there is a capability that is missing and would make development easier and more robust, please submit a [feature request](https://github.com/amplication/amplication/issues/new?assignees=&labels=type%3A+feature+request&template=feature.yml).
280+
281+
- Documentation Request: If you're reading the Amplication docs and feel like you're missing something, please submit a [documentation request](https://github.com/amplication/amplication/issues/new?assignees=&labels=type%3A+docs&template=documentation-request.yaml&title=%F0%9F%93%96+Documentation%3A+).
282+
283+
Not sure where to start? Join our discord and we will help you get started!
284+
285+
<a href="https://amplication.com/discord"><img src="https://amplication.com/images/discord_banner_purple.svg" /></a>
286+
287+
## Contributors
288+
289+
<!---
290+
npx contributor-faces --exclude "*bot*" --limit 70 --repo "https://github.com/amplication/amplication"
291+
292+
change the height and width for each of the contributors from 80 to 50.
293+
--->
294+
295+
[//]: contributor-faces
296+
<a href="https://github.com/fabiobrasileiroo"><img src="https://avatars.githubusercontent.com/u/43705455?v=4" title="yuval-hazaz" width="50" height="50"></a>
297+
<a href="https://github.com/iddan"><img src="https://avatars.githubusercontent.com/u/12671072?v=4" title="iddan" width="50" height="50"></a>
298+
299+
[//]: contributor-faces
300+
301+
## License
302+
303+
[![Typing SVG](https://readme-typing-svg.herokuapp.com/?color=00ffdf&size=35&center=true&vCenter=true&width=1000&lines=HELLO,+My+name+is+Fabio+Brasileiro;I'm+from+Brazil,+Amazonas,+Manaus;I+Studying+software+engineering+;Be+Welcome!+:%29)](https://git.io/typing-svg)
304+
153305
<details>
154306
<summary><h3>👨‍💻 Por que é divertido programar?</h3><img src="https://media.giphy.com/media/WUlplcMpOCEmTGBtBW/giphy.gif" width="30"> </summary>
155307
Pela satisfação de construir algo. Da mesma forma que crianças se divertem montando peças de LEGO, adultos se divertem construindo coisas um pouco mais complexas. Geralmente ficamos felizes quando construímos coisas úteis para alguém. Também ficamos felizes quando fazemos atividades não repetitivas, e quando temos aprendizagem constante.

0 commit comments

Comments
 (0)