Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/itsdrvgo/ezymetrics
https://github.com/itsdrvgo/ezymetrics
Last synced: 9 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/itsdrvgo/ezymetrics
- Owner: itsdrvgo
- Created: 2024-10-22T11:36:14.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-10-22T11:36:17.000Z (2 months ago)
- Last Synced: 2024-12-06T07:22:48.100Z (17 days ago)
- Language: TypeScript
- Size: 62.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# EzyMetrics Internship Assignment
### **Task:**
Build a Backend for EzyMetrics Focusing on Data Integrations and Reporting
### Requirements:
1. **API Service Development:**
- Integrate with dummy CRM and Marketing platforms.
- Simulate fetching lead and campaign data via dummy data.
2. Data Storage and Processing:
- Use a relational or NoSQL database to store the fetched data.
- Build an ETL process to transform raw data into meaningful metrics.
3. Reporting and Alerts:
- Implement an API endpoint to generate reports (PDF/CSV).
- Include basic email notifications for alerts when certain conditions are met.
4. Submission:
- GitHub repository link for the API.
- README detailing API usage and instructions.
## Getting Started:
### Technologies Used:
- **Core**
- **Node.js** - JavaScript runtime built on Chrome's V8 JavaScript engine.
- **TypeScript** - Typed superset of JavaScript that compiles to plain JavaScript.
- **Hono** - Fast, lightweight, built on Web Standards. Support for any JavaScript runtime.
- **Drizzle ORM** - A simple, lightweight, type-safe and fast ORM for Node.js.
- **Postgres** - Open-source relational database system.
- **Zod** - TypeScript-first schema declaration and validation library.
- **React Email** - A library for building responsive email templates.
- **T3 ENV** - A library for managing environment variables in TypeScript.
- **NodeMailer** - A module for Node.js applications to allow easy email sending.
- **Development**
- **Bun** - A simple, fast, and lightweight build tool for Node.js.
- **Drizzle Kit** - A CLI tool for generating and managing database migrations.
- **ESLint** - A tool for identifying and reporting on patterns found in ECMAScript/JavaScript code.
- **Total TypeScript** - A TypeScript configuration for projects.
- **Prettier** - An opinionated code formatter.
> ### Notes:
>
> - This project uses locally hosted Postgres database.
> - Instead of Express, this project uses Hono, a lightweight alternative.
> - The project uses Drizzle ORM for database operations.
> - The project uses Zod for schema validation.
> - This project uses Nodemailer with Gmail SMTP for sending emails.
### Installation:
1. Clone the repository:
```bash
git clone
```
2. Install the dependencies:
```bash
# Using npm
npm install
# Using yarn
yarn install
# Using pnpm
pnpm install
# Using bun
bun install
```
3. Set up the environment variables:
```bash
cp .env.example .env
```
4. Running the migrations:
```bash
# Using bun
bun run db:mig
```
5. Start the development server:
```bash
# Using bun
bun run dev
```
6. Access the API at `http://localhost:3001`.
7. Open Postman and import the collection from the `postman` directory.
8. The base API URL is `http://localhost:3001/api/v1`.
### API Endpoints:
Visit the [API Documentation](/API_DOCS.md) for more information.
## Connect with me
[](https://instagram.com/itsdrvgo)
[](https://linkedin.com/in/itsdrvgo)
[](https://twitch.tv/itsdrvgo)
[](https://x.com/itsdrvgo)
[](https://youtube.com/@itsdrvgodev)