README.md

MDitor

Hey! here is a MarkDown Editor to make your crazy notes! but take it care this is just an alpha, we are working on getting MDitor better 😁

• 🎨 Check Demo MDitor http://mditor.surge.sh/#/

• 👨‍🚀 Check Demo Cosmos MDitor http://cosmos-mditor.surge.sh/

⚠️ Hey! if you want to know how we have done MDitor, you can navigate to ./doc

⚡️ If you just want to know how dowload it, test or add new features, follow theses steps ⬇️

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

You need these technologies to run the EDitor project on your local machine

• Install Node
• Install MongoDB
• npm TypeScript

npm install -g typescript

Installing

Clone gitHub repo in your local machine

git clone https://github.com/VGamezz19/MDitor.git

go inside! 🧐

cd /MDitor

then, enter in ./api and ./mditor-types and install and build project

api

cd /api

yarn || npm install

yarn build || npm run build

mditor-types

cd ../mditor-types

yarn || npm install

yarn build || npm run build

server

cd ../server

yarn || npm install

yarn build || npm run build

yarn start || npm run start

Finally, go inside ./client and install dependencies

client

cd ../client

yarn || npm install

yarn start || npm run start

this last command will open new windows in your default browser with MDitor! 😁 👍

Running the tests

Client

navigate to ./client and then ejecute this command:

cd MDitor/client

yarn test || npm run test

It will ejecute Jest test and verify if all components mount correctly.

Then, you can open Cosmos 👨‍🚀 Demo:

yarn cosmos || npm run cosmos

Enter URL 127.0.0.1:8989 in your browsert and test it! 👍

API-Client

navigate to ./api and then ejecute this command:

cd MDitor/api

yarn test || npm run test

It will test all api logic (file, folder and user)

MDitor-types

navigate to ./mditor-types and then ejecute this command:

cd MDitor/mditor-types

yarn test || npm run test

It will test the data type File

Server

navigate to ./server and then ejecute this command:

cd MDitor/server

yarn test || npm run test

It will test all server logic (file, folder and user)

Authors

• Victor Gamez - web-developer - VGamezz19

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License