https://github.com/wallacefreitas/broker-listing

https://github.com/wallacefreitas/broker-listing

Last synced: 30 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/wallacefreitas/broker-listing
• Owner: wallacefreitas
• Created: 2024-08-15T18:51:16.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-08-16T11:19:46.000Z (5 months ago)
• Last Synced: 2024-10-16T22:03:39.787Z (3 months ago)
• Language: TypeScript
• Homepage: https://broker-listings.fly.dev/
• Size: 52.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## 🚀 Challenge

This repo was development using Node.js with TS/JS, Postgres, Chart.js and Handlebars. The main idea of this project was to use some design patterns with Clean Architecture.

To acccess the project, click here

Below I explained a little of patterns:

#### Clean Architecture - Backend

Using of layers concepts where external layer inject resources going to core application

## 🛠 Tech & Frameworks

In this projects the following technologies and frameworks were used:

| Tool            |     Used in   |

|---------------- |:-------------:|

| Node.js (v20)   |      🟢       |

| Express.js      |      🟢       |

| TypeScript      |      🟢       |

| TailwindCSS     |      🟢       |

| Chart.js        |      🟢       |

| Postgres (pg)   |      🟢       |

| handlebars      |      🟢       |

| Vitest          |      🟢       |

| pnpm            |      🟢       |

Legend: 


🟢 = Backend 


To more info:

> [Backend] See the file  [package.json](./package.json)

## 🧭 Running

### Clonning this repository

```bash

# Clone this repository

$ git clone https://github.com/wallacefreitas/broker-listing.git

```

---

#### Running in a server (Backend) 

>🚨 IMPORTANT: use Node v20 or latest




```bash

# Access the folder project in your terminal/cmd

$ cd broker-listings

# Rename the file .env.sample to .env

mv .env.sample .env

# Install the dependencies

$ pnpm install

# Run the application in development mode

$ pnpm run dev

# Run tests of application - Optional

$ pnpm run test

# The application will open in port:3001 - go to http://localhost:3001

```

## 🧪 Coverage

![image](https://github.com/user-attachments/assets/7f5bee06-583b-4eea-b1de-ca8fb36a621a)

## ⚙️ Services

| App             |    Host                             |   Port        |

|---------------- |:-----------------------------------:|:-------------:|

| backend         |  localhost                          |   3001        |

## 🔮 Future Implementations

✓ Better coverage of tests 


## 📝 License

Made with ♥️ by Wallace de Freitas