Skip to content

Latest commit

 

History

History
58 lines (39 loc) · 1.75 KB

opensource-2.md

File metadata and controls

58 lines (39 loc) · 1.75 KB

Project name

Project description.

[Add Badges

Note: Some observations if you need them (optional).

Features

  • Feature 1
  • Feature 2
  • Feature 3

Quick start

Here you can tell us how to get your project up and running.

You can add commands like: run npm install and npm run serve.

It's important that you let everything clear and tell us as much information as possible.

API/Route Table (optional)

Route Description
/login
/example List of all examples
/example-new Create a new example
/example-edit/:id Edit a example, by passing his id
/* Goes to a not found page

Contributing contributions welcome

Thank you for considering contributing to Your Project Name!

Please first note we have a code of conduct, please follow it in all your interactions with the project.

We welcome any type of contribution, not only code. You can help with:

  • QA: File bug reports, the more details you can give the better (e.g. screenshots with the console open)
  • Community: Presenting the project at meetups, organizing a dedicated meetup for the local community
  • Code: Take a look at the open issues. Even if you can't write the code yourself, you can comment on them, showing that you care about a given issue matters. It helps us triage them

Demo

Create a demo and host it somewhere.

TODO

  • Add E2E tests.
  • Add Unit tests.
  • Add more functionalities.
  • Add ...