Skip to content

Commit

Permalink
feat: add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@SamuelS00
SamuelS00 committed Nov 8, 2022
1 parent 5cd1dc2 commit 3f96da0
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,20 @@

# About

This challenge deals with the development of a Back-end application in Node.js using Express, applying the principles of Object Oriented Programming (`OOP`) to build an API with `CRUD` to manage a car dealership. This will be done using the `MongoDB` database.
This challenge deals with the development of a Back-end application in Node.js using Express, applying the principles of Object-Oriented Programming (`OOP`) to build an API with `CRUD` to manage a car dealership. This will be done using the `MongoDB` database.

following `MSC` software architecture (Model - Service - Controller) and `REST` web architecture principles, connecting to a `MySQL` database for information persistence.
Following `MSC` software architecture (Model - Service - Controller) and `REST` web architecture principles, connecting to a `MySQL` database for information persistence.

# ****Technologies Used****

![TypeScript](https://img.shields.io/badge/TypeScript-05122A?style=flat&logo) 
![JavaScript](https://img.shields.io/badge/-JavaScript-05122A?style=flat&logo=javascript) 
![Node.js](https://img.shields.io/badge/-Node.js-05122A?style=flat&logo=node.js) 
![Express](https://img.shields.io/badge/-Express-05122A?style=flat&logo=express) 
![MongoDB](https://img.shields.io/badge/MongoDB-4EA94B?style=flat&logo=mongodb&logoColor=white) 
![MongoDB](https://img.shields.io/badge/MongoDB-05122A?style=flat&logo=mongodb) 
![ESLint](https://img.shields.io/badge/-ESLint-05122A?style=flat&logo=eslint) 
![Chai](https://img.shields.io/badge/-Chai-05122A?style=flat&logo=chai) 
![Mocha](https://img.shields.io/badge/-Mocha-05122A?style=flat&logo=mocha) 
![Sinon](https://img.shields.io/badge/-Sinon-05122A?style=flat&logo=sinon) 
![Git](https://img.shields.io/badge/-Git-05122A?style=flat&logo=git)&nbsp 
![GitHub](https://img.shields.io/badge/-GitHub-05122A?style=flat&logo=github) 
![Markdown](https://img.shields.io/badge/-Markdown-05122A?style=flat&logo=markdown) 
Expand Down Expand Up @@ -88,6 +87,6 @@ If you don't have MongoDB installed on your machine and want to use Docker, just

# Documentation

go to `http://localhost/3000/docs`
go to `http://localhost/3001/docs`

![1667081534004](image/README/1667081534004.png)
![1227839930382](image/README/1227839930382.png)
Binary file added image/README/1227839930382.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed image/README/1667081534004.png
View file
Binary file not shown.

0 comments on commit 3f96da0

Please sign in to comment.