Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/siykt/nodejs-server-template
A koa server template for nodejs
https://github.com/siykt/nodejs-server-template
koa nodejs template-project
Last synced: 9 days ago
JSON representation
A koa server template for nodejs
- Host: GitHub
- URL: https://github.com/siykt/nodejs-server-template
- Owner: Siykt
- License: mit
- Created: 2024-02-26T08:24:58.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-03-08T07:40:55.000Z (11 months ago)
- Last Synced: 2025-02-01T17:44:29.612Z (9 days ago)
- Topics: koa, nodejs, template-project
- Language: TypeScript
- Homepage:
- Size: 8.79 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# A koa server template for nodejs
This project is an open-source template for building server-side applications using Koa, TypeScript, tsup for building, and integrated ESLint + Prettier for code formatting and linting. It is designed to provide a starting point for developers looking to create robust, scalable, and maintainable web services or APIs.
## Features
- **Koa Framework**: Utilizes Koa for handling HTTP requests with a minimalistic and flexible approach.
- **TypeScript Support**: Leverages TypeScript for strong typing and enhanced development experience.
- **tsup for Building**: Uses tsup for efficient and fast TypeScript compilation.
- **ESLint + Prettier**: Integrated ESLint and Prettier for consistent code formatting and linting, ensuring code quality and style consistency.
- **Advanced REST Architecture**: Features a polished RESTful architecture with efficient route management for streamlined API development.
- **zod-based DTO Validation**: Introduces zod for clear, concise DTO middleware, greatly simplifying data validation and structuring.
## Getting Started
### Prerequisites
- Node.js (Version recommended: 14.x or later)
- npm/yarn
### Installation
1. Clone the repository:
```bash
git clone https://github.com/Siykt/nodejs-server-template.git
```
2. Install dependencies:
```bash
cd nodejs-server-template
npm install
```
or if you prefer yarn,
```bash
yarn
```
### Running the Server
To start the server in development mode, run:
```bash
npm run dev
```
or using yarn,
```bash
yarn dev
```
The server will reload automatically on file changes thanks to ts-node-dev.
### Building the Project
To compile TypeScript to JavaScript, run:
```bash
npm run build
```
or using yarn,
```bash
yarn build
```
The build output will be in the `dist` folder.
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request or create an issue for any enhancements, bug fixes, or feature requests.
## License
This project is open-source and available under the [MIT License](LICENSE).