https://github.com/thuongtruong109/flowcal

📅 Manage schedules within intuitive boards and calendar flows
https://github.com/thuongtruong109/flowcal

board calendar event kanban kanban-board kanboard management notes schedule task task-management todolist

Last synced: 9 months ago
JSON representation

📅 Manage schedules within intuitive boards and calendar flows

• Host: GitHub
• URL: https://github.com/thuongtruong109/flowcal
• Owner: thuongtruong109
• Created: 2024-09-11T13:37:15.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2025-03-01T09:35:05.000Z (9 months ago)
• Last Synced: 2025-03-01T10:28:16.568Z (9 months ago)
• Topics: board, calendar, event, kanban, kanban-board, kanboard, management, notes, schedule, task, task-management, todolist
• Language: Vue
• Homepage:
• Size: 15.1 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • Code of conduct: .github/CODE_OF_CONDUCT
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
# 🚀 flowcal

[![CI](https://github.com/thuongtruong109/flowcal/actions/workflows/ci.yml/badge.svg)](https://github.com/thuongtruong109/flowcal/actions/workflows/ci.yml)

[![CD](https://github.com/thuongtruong109/flowcal/actions/workflows/cd.yml/badge.svg)](https://github.com/thuongtruong109/flowcal/actions/workflows/cd.yml)

```code

Hey There! 🙌

🤾 that ⭐️ button if you like this boilerplate.

```

## 💡 Motivation

This boilerplate aims to:

- ✨ Reduce setup time for new projects

- 📊 Ensure code consistency and quality

- ⚡ Facilitate rapid development

- 🛡️ Encourage best practices in security, testing, and performance

## 🚀 Features

- 📁 Modular Structure: Organized by feature for easy navigation and scalability

- 💨 Faster Execution with tsx: Rapid TypeScript execution with `tsx` and type checking with `tsc`

- 🌐 Stable Node Environment: Latest LTS Node version in `.nvmrc`

- 🔧 Simplified Environment Variables: Managed with Envalid

- 🔗 Path Aliases: Cleaner code with shortcut imports

- 🔄 Renovate Integration: Automatic updates for dependencies

- 🔒 Security: Helmet for HTTP header security and CORS setup

- 📊 Logging: Efficient logging with `pino-http`

- 🧪 Comprehensive Testing: Setup with Vitest and Supertest

- 🔑 Code Quality Assurance: Husky and lint-staged for consistent quality

- ✅ Unified Code Style: `Biomejs` for consistent coding standards

- 📃 API Response Standardization: `ServiceResponse` class for consistent API responses

- 🐳 Docker Support: Ready for containerization and deployment

- 📝 Input Validation with Zod: Strongly typed request validation using `Zod`

- 🧩 Swagger UI: Interactive API documentation generated from Zod schemas

## 🛠️ Getting Started

#### Step 1: 🚀 Initial Setup

- Clone the repository: `git clone https://github.com/thuongtruong109/flowcal.git`

- Navigate: `cd flowcal`

- Install dependencies: `npm ci`

#### Step 2: ⚙️ Environment Configuration

- Create `.env`: Copy `.env.example` to `.env`

- Update `.env`: Fill in necessary environment variables

#### Step 3: 🏃‍♂️ Running the Project

- Development Mode: `npm run dev`

- Building: `npm run build`

- Production Mode: Set `.env` to `NODE_ENV="production"` then `npm run build && npm run start`

## 🤝 Feedback and Contributions

We'd love to hear your feedback and suggestions for further improvements. Feel free to contribute and join us in making backend development cleaner and faster!

🎉 Happy coding!