An open API service indexing awesome lists of open source software.

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

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).