Skip to content

Latest commit

 

History

History
98 lines (58 loc) · 2.96 KB

README.md

File metadata and controls

98 lines (58 loc) · 2.96 KB
Raw

Text Editor ✍

react Underdevelopment

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, this interface and the layout ware made from scratch by me.

API

For building the server of this application, I used Hy Graph that is an CMS that allow us to build GraphQL 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 and then:

  • Create a new project
  • Inside your project, go to "Project Settings"
  • Inside settings, access the tab "API Access"
  • Add all permisions

Captura de Tela 2023-03-19 às 14 54 48

  • Copy your Content API URL and use as process.env.REACT_APP_CONTENT_API_URL

Captura de Tela 2023-03-19 às 15 03 58

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

Captura de Tela 2023-03-19 às 15 04 32

Start server

  //in root
  npm start

👩‍💻 Contribute

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

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

Commit pattern

📃 License

This project is under MIT license