Skip to content

Commit

Permalink
fix(readme): improve our readme file
Browse files Browse the repository at this point in the history
add technology stacks
add database badgies
add all tools we use in project development
  • Loading branch information
kwizera-bonheur25 committed Apr 22, 2024
1 parent abbc596 commit ef242fe
Showing 1 changed file with 17 additions and 14 deletions.
31 changes: 17 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,25 @@
[![Coverage Status](https://coveralls.io/repos/github/atlp-rwanda/hackers-ec-be/badge.svg?branch=feat-test-CI-implementation-187419042)](https://coveralls.io/github/atlp-rwanda/hackers-ec-be?branch=feat-test-CI-implementation-187419042)
[![Coverage Status](https://coveralls.io/repos/github/atlp-rwanda/hackers-ec-be/badge.svg?branch=develop)](https://coveralls.io/github/atlp-rwanda/hackers-ec-be?branch=develop)
[![Maintainability](https://api.codeclimate.com/v1/badges/0f9cac26fd6bc0a2f7a9/maintainability)](https://codeclimate.com/github/atlp-rwanda/hackers-ec-be/maintainability)
[![Test Coverage](https://api.codeclimate.com/v1/badges/0f9cac26fd6bc0a2f7a9/test_coverage)](https://codeclimate.com/github/atlp-rwanda/hackers-ec-be/test_coverage)
![](https://img.shields.io/badge/Express.js-404D59?style=for-the-badge)
![](https://img.shields.io/badge/Node.js-43853D?style=for-the-badge&logo=node.js&logoColor=white)
![](https://img.shields.io/badge/PostgreSQL-316192?style=for-the-badge&logo=postgresql&logoColor=white)
![](https://img.shields.io/badge/sequelize-323330?style=for-the-badge&logo=sequelize&logoColor=blue)

![](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white)
![](https://img.shields.io/badge/GitHub_Actions-2088FF?style=for-the-badge&logo=github-actions&logoColor=white)
![](https://img.shields.io/badge/Jest-323330?style=for-the-badge&logo=Jest&logoColor=white)
![](https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white)

# hackers-ec-be

![Static Badge](https://img.shields.io/badge/database-postgressSQL-blue?style=flat&labelColor=%23ff6e15)
![Static Badge](https://img.shields.io/badge/Testing-Jest-brown?style=flat-square&labelColor=green)
![Static Badge](https://img.shields.io/badge/Auth_Library-PassportJs-yellow?style=flat-square&labelColor=%2327c2a0)
![Static Badge](https://img.shields.io/badge/ESLINT-Code_style-%232796C2?style=flat-square&labelColor=%2396c900)
[![Reviewed by Hound](https://img.shields.io/badge/Reviewed_by-Hound-8E64B0.svg)](https://houndci.com) ![NPM Version](https://img.shields.io/npm/v/node) ![NPM License](https://img.shields.io/npm/l/node?style=flat-square&labelColor=%23E6684A&color=blue)

![Static Badge](https://img.shields.io/badge/Accepting-Pull_Request-%23005B96?style=for-the-badge)

# ShopTrove E-Commerce app

Welcome to <b>ShopTrove</b>, an Excellent E-commerce destination! Browse thousands of products from top brands, enjoy exclusive deals, and personalized recommendations. With secure payments and fast delivery, ShopTrove makes shopping a breeze. <br><br> This READMe file explains in detail how our app works and how to run it in your local development environment.

## Stack development
[![Development stacks](https://skillicons.dev/icons?i=typescript,express,nodejs,jest&theme=light)](https://skillicons.dev)
## Database, ORM and data storage
[![Database, ORM and data storage](https://skillicons.dev/icons?i=postgres,sequelize&theme=light)](https://skillicons.dev)
## Continuous integration
[![Continuous integration](https://skillicons.dev/icons?i=githubactions&theme=light)](https://skillicons.dev)
## Version control
[![Version control](https://skillicons.dev/icons?i=github,git&theme=light)](https://skillicons.dev)
## API documentation
<a href="https://hackers-ec-be.onrender.com/api/v1/docs/">![Swagger](https://img.shields.io/badge/-Swagger-%23Clojure?style=for-the-badge&logo=swagger&logoColor=white)</a>

0 comments on commit ef242fe

Please sign in to comment.