https://github.com/skygenesisenterprise/api-web-starter
The Open Dev Github Web API Starter
https://github.com/skygenesisenterprise/api-web-starter
javascript nodemon openapi talwindcss typescript vite yarn
Last synced: 6 months ago
JSON representation
The Open Dev Github Web API Starter
- Host: GitHub
- URL: https://github.com/skygenesisenterprise/api-web-starter
- Owner: skygenesisenterprise
- License: mit
- Created: 2025-08-05T05:42:51.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-08-05T05:52:31.000Z (8 months ago)
- Last Synced: 2025-09-22T05:26:00.815Z (6 months ago)
- Topics: javascript, nodemon, openapi, talwindcss, typescript, vite, yarn
- Language: CSS
- Homepage: https://skygenesisenterprise.com
- Size: 20.5 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Github API Web Starter
A modern, ready-to-use API starter template built with TypeScript and Express.js.
This project is designed for web developers who want to bootstrap a scalable, secure, and production-ready backend with minimal setup.
## โจ Features
- โ
Built with TypeScript
- โ๏ธ Express.js RESTful API structure
- ๐งช Integrated testing with Jest and Supertest
- ๐งน Pre-configured ESLint, Prettier, and Husky
- ๐ณ Docker-ready for deployment and development
- ๐ Security enhancements via Helmet and CORS
- ๐งพ Request logging with Morgan
- ๐ OpenAPI (Swagger) support
- ๐ฆ CI/CD ready with GitHub Actions workflows
## ๐งช Testing
Run tests using:
```bash
npm run test
````
Includes unit and API endpoint tests using `jest` and `supertest`.
## ๐ Usage
```bash
# Clone the repo
git clone https://github.com/skygenesisenterprise/api-web-starter.git
cd api-web-starter
# Install dependencies
npm install
# Run in development mode
npm run dev
# Build for production
npm run build
```
## ๐ณ Docker
To run the API in a Docker container:
```bash
docker build -t github-api-web-starter .
docker run -p 3000:3000 github-api-web-starter
```
## ๐ข Maintained by
**Sky Genesis Enterprise โ Open Dev Division**
Building open and collaborative tech resources for the future.
## ๐ License
This project is licensed under the [MIT License](./LICENSE).