Text Editor ✍

Technologies • Getting Started • Contribute • License

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

<img src="https://github.com/Fernanda-Kipper/text-editor/raw/main/github/assets/file-edit.png" width="300px">
<img src="https://github.com/Fernanda-Kipper/text-editor/raw/main/github/assets/files.png" width="300px">

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

• 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!

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