Skip to content
Open
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
19 changes: 6 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
<h1 align="center" style="font-weight: bold;">Text Editor ✍</h1>

123
![react](https://img.shields.io/badge/React-blue?style=flat&logo=react)
![Underdevelopment](https://img.shields.io/badge/GraphQL-e10098?style=flat&logo=graphql)


<p align="center">
<a href="#tech">Technologies</a> •
<a href="#started">Getting Started</a> •
Expand All @@ -20,14 +19,15 @@
<img src="./.github/assets/files.png" width="300px">
</p>


<h2 id="tech">Technologies</h2>

### Client:
Built using [React JS](https://pt-br.reactjs.org/), this interface and the layout ware made from scratch by me.

Built using [React JS](https://pt-br.reactjs.org/), this interface and the layout ware made from scratch by me.

### API
For building the server of this application, I used [Hy Graph](https://hygraph.com/) that is an CMS that allow us to build [GraphQL](https://graphql.org/) Content APIs.

For building the server of this application, I used [Hy Graph](https://hygraph.com/) that is an CMS that allow us to build [GraphQL](https://graphql.org/) Content APIs.

<h2 id="started">🚀 Getting Started</h2>

Expand Down Expand Up @@ -60,13 +60,10 @@ To get these values you need to create an Account on [HyGraph](https://app.hygra

<img width="393" alt="Captura de Tela 2023-03-19 às 15 03 58" src="https://user-images.githubusercontent.com/61896274/226197693-4ec3bb2e-12b3-44b5-8f69-bfa7256760eb.png">


- Generate an Permanent Auth Tokens and use as `process.env.REACT_APP_CONTENT_API_TOKEN`

<img width="371" alt="Captura de Tela 2023-03-19 às 15 04 32" src="https://user-images.githubusercontent.com/61896274/226197729-924da132-490d-4f6d-84bd-201fb54fa07b.png">



<h4>Start server</h4>

```
Expand All @@ -83,16 +80,12 @@ git clone https://github.com/Fernanda-Kipper/text-editor.git
git checkout -b feature/NAME
```

At the end, open a Pull Request explaining the problem solved or feature made, if exists, append screenshot of visual modifications and wait for the review!
At the end, open a Pull Request explaining the problem solved or feature made, if exists, append screenshot of visual modifications and wait for the review!

[How to create a Pull Request](https://www.atlassian.com/br/git/tutorials/making-a-pull-request)

[Commit pattern](https://gist.github.com/joshbuchea/6f47e86d2510bce28f8e7f42ae84c716)


<h2 id="license">📃 License</h2>

This project is under [MIT](./.github/LICENSE) license