Skip to content

Latest commit

 

History

History
152 lines (122 loc) · 5.9 KB

README.md

File metadata and controls

152 lines (122 loc) · 5.9 KB

[YOUR_PROJECT_TITLE]

[YOUR_PROJECT_SLOGAN]

[YOUR_PROJECT_TITLE] Logo

Preview   |    Live Version   |    Tech Stack   |    Features   |    Roadmap   
Run   |    Usage / Docs   |    Contribute / License   |    Stats   |    Credits   


[:bulb:] Why?

Here's your project's elevator pitch! This is where you have the chance to shine and briefly describe the core concept of your project. Share the driving force behind its creation, the unique value it offers, or any captivating backstory. Imagine your audience includes visitors, potential users, contributors, recruiters, or even that special someone. What will you convey here to capture their attention and entice them to explore your project further? Get creative, make it engaging, and leave a lasting impression!


[:telescope:] Preview


[:link:] Live Version

> If hosted, use:

Give it a try!

> If not, use:

Not available, check the running instructions.


[:toolbox:] Tech Toolbox

  • Tech/Language (e.g. React)
  • Another tech/language (e.g. Nest.js)
  • A relevant library you used (e.g. Chalk)
  • A methodology or good practice (e.g. Conventional Commits/Clean Code)
  • An used architecture (e.g. MVC)

[:chains:] Features Highlights

  • A feature that does that incredible thing
  • That other built-in solution you made
  • That cool thing worth mentioning
  • Oh, and that other one

[:spiral_notepad:] Future Implementations

- [X] Add `temp-late` as documentation template for the project
- [ ] [TASK_2_DESCRIPTION]
- [ ] [TASK_3_DESCRIPTION]
- [ ] [TASK_4_DESCRIPTION]

[:key:] Running The Application

> Change this accordingly to your project setup. The exact same way you would do in your computer.

$ git clone [YOUR_PROJECT_REPO_URL]
$ npm install
$ npm run start

> Or use:

Not available, check the live version.


[:page_facing_up:] Usage / Documentations

> If applicable, built a cool one.

> If not, use:

No documentation needed in this project. Simply run the application.


[:ballot_box:] Contribution / License

This project is sprinkled with the open-source enchantment of the [PROJECT_LICENSE]. Feel free to dive into the code, contribute your wizardry, and craft your own magical creations. Let's conjure some innovation together! ✨🔮

View License

[:shield:] Badges

GitHub repo size GitHub language count GitHub forks GitHub stars GitHub commit activity
GitHub open issues GitHub open pull requests GitHub closed pull requests


[:handshake:] Acknowledgements

  • Author: [YOUR_NAME];
  • Contributions: [NAME_1], [NAME_2];
  • Inspired on [INSPIRATION_PROJECT_NAME] by [INSPIRATION_AUTHOR_NAME];
  • Thanks to temp-late for the help in the documentation structure;

(back to top)