Skip to content

Latest commit

 

History

History
124 lines (91 loc) · 4.39 KB

README.md

File metadata and controls

124 lines (91 loc) · 4.39 KB
Raw

MdEditor

Web application for writing metadata. Built using ember.js. Go to https://www.mdeditor.org/ to use the application.

Table of Contents generated with DocToc

Prerequisites (for development)

You will need the following things properly installed on your computer.

  • [Git][git]
  • [Node.js][node]
    • Supported versions: v18.
    • Apple Silicon Users: if you experience problems building or running try Node v14.
    • We are now using Yarn V4. Here are the steps in setting it up.
      • Make sure that you have Node Version 18 doesn't matter the minor semantic changes.
      • Enable corepack by using the corepack enable command.
      • Remove node_modules folder
      • Run yarn to install packages again using Yarn V4.
      • All other commands are the same.
  • [Yarn][yarn] installed globally
  • [Google Chrome][chrome]
  • [Firefox][firefox]

Installation

  • git clone https://github.com/adiwg/mdEditor.git this repository
  • cd mdEditor change into the new directory
  • yarn install

List of available project commands. yarn run <command-name>

Command Description
build:development Builds the application in development mode.
build Builds the application for production.
lint Runs all lint commands.
lint:hbs Lints hbs template files.
lint:js Lints js files.
lint:sass Lints scss files.
format Runs all auto-formatters.
format:js Auto-formats js files using Prettier.
format:sass Auto-formats scss files using Prettier.
start Runs the dummy app local server.
test Runs all tests in random order, with coverage reporting.
doc:toc Automatically generates a table of contents for this README file.

Contributing

See CONTRIBUTING.md for info on making contributions.

Also, see the wiki for more info about the project.

Branching

Building ToC

To autogenerate a ToC (table of contents) for this README, run yarn doc:toc. Please update the ToC whenever editing the structure of README.

Running / Development

Building Application for Production

To build this UI for production, run the following commads from this folder:

yarn install
yarn build

Running Tests

  • npm test runs full tests in random order with coverage
  • ember test --server

Keep in mind that tests are executed in random order. This is intentional and helps to prevent hard-to-debug order dependencies among tests.

Please also note that we report test coverage. We strive for "the right amount of testing". Use test coverage as a guide to help you identify untested high-value code.

We rely on ember-a11y-testing to validate accessibility in acceptance tests. If you write acceptance tests, please ensure at least one validation per route using await a11yAudit();.

Deploying

By default, this will deploy to GitHub pages:

ember deploy staging

Note that the gh-pages branch must exist in the git repository. See ember-cli-deploy-git for details. Visit https://.github.io/mdEditor

Further Reading / Useful Links