https://github.com/fernanda-kipper/text-editor

Online Text Editor where users can create and edit markdown files
https://github.com/fernanda-kipper/text-editor

graphql javascript reactjs typescript

Last synced: 1 day ago
JSON representation

Online Text Editor where users can create and edit markdown files

• Host: GitHub
• URL: https://github.com/fernanda-kipper/text-editor
• Owner: Fernanda-Kipper
• Created: 2022-02-11T12:36:52.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-07-30T22:36:01.000Z (5 months ago)
• Last Synced: 2024-12-31T13:10:02.343Z (8 days ago)
• Topics: graphql, javascript, reactjs, typescript
• Language: TypeScript
• Homepage:
• Size: 1.13 MB
• Stars: 60
• Watchers: 4
• Forks: 44
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
Text Editor ✍


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

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



 Technologies • 

 Getting Started • 

 Contribute •

 License





This application is a online Text Editor, where users can create and edit markdown files.





    

    



Technologies


### Client:

  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.

🚀 Getting Started


 Prerequisites


- Node 12

- Git 2

Install project


```

git clone https://github.com/Fernanda-Kipper/text-editor.git

npm install

```

Environment Variables


In the root of this project, create a `.env` file with the keys and values located on `.env.example`

To get these values you need to create an Account on [HyGraph](https://app.hygraph.com/) and then:

- Create a new project

- Inside your project, go to "Project Settings"

- Inside settings, access the tab "API Access"

- Add all permisions



- Copy your **Content API URL** and use as `process.env.REACT_APP_CONTENT_API_URL`



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



Start server


```

  //in root

  npm start

```

👩‍💻 Contribute


If you want to contribute, clone this repo, create your work branch and get your hands dirty!

```bash

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!

[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)

📃 License


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