https://github.com/patrickgdl/goto
Attempt to communicate with the GoTo Connect APIs
https://github.com/patrickgdl/goto
express nodejs typescript
Last synced: 3 months ago
JSON representation
Attempt to communicate with the GoTo Connect APIs
- Host: GitHub
- URL: https://github.com/patrickgdl/goto
- Owner: patrickgdl
- Created: 2024-05-20T21:18:48.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-21T18:01:32.000Z (about 2 years ago)
- Last Synced: 2025-07-19T18:40:28.767Z (12 months ago)
- Topics: express, nodejs, typescript
- Language: TypeScript
- Homepage:
- Size: 121 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# 🚀 Express with TypeScript
## 💡 Motivation and Intentions
Developed to streamline backend development, a solution for:
- ✨ Reducing setup time for new projects.
- 📊 Ensuring code consistency and quality.
- ⚡ Facilitating rapid development with cutting-edge tools.
- 🛡️ Encouraging 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 esbuild, complemented by tsc for type checking.
- 🌐 Stable Node Environment: Latest LTS Node version in .nvmrc.
- 🔧 Simplified Environment Variables with Envalid: Centralized and easy-to-manage configuration.
- 🔗 Path Aliases: Cleaner code with shortcut imports.
- 🔄 Dependabot Integration: Automatic updates for secure and up-to-date dependencies.
- 🔒 Security: Helmet for HTTP header security and CORS setup.
- 📊 Logging: Efficient logging with pino-http.
- 🧪 Comprehensive Testing: Robust setup with Vitest and Supertest.
- 🔑 Code Quality Assurance: Husky and lint-staged for consistent quality.
- ✅ Unified Code Style: ESLint and Prettier for a consistent coding standard.
- 📃 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.
- 🧩 API Spec Generation: Automated OpenAPI specification generation from Zod schemas to ensure up-to-date and accurate API documentation.
## 🛠️ Getting Started
### Step 1: 🚀 Initial Setup
- Clone the repository: `git clone https://github.com/patrickgdl/goto`
- Navigate: `cd goto`
- Install dependencies: `npm ci`
### Step 2: ⚙️ Environment Configuration
- Create `.env`: Copy `.env.template` 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`
## 📁 Project Structure
```
.
├── api
│ ├── healthCheck
│ │ └── healthCheckRouter.ts
│ └── goto
│ ├── goto-router.ts
├── common
│ ├── __tests__
│ │ ├── errorHandler.test.ts
│ │ └── requestLogger.test.ts
│ ├── middleware
│ │ ├── errorHandler.ts
│ │ └── requestLogger.ts
│ ├── models
│ │ └── serviceResponse.ts
│ └── utils
│ ├── commonValidation.ts
│ ├── envConfig.ts
│ └── httpHandlers.ts
├── index.ts
└── server.ts
```