Ecosyste.ms: Awesome

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

https://github.com/basemax/simple-api-typescript

A lightweight and minimal REST API built with TypeScript, Express, and SQLite.
https://github.com/basemax/simple-api-typescript

bun express-js express-ts expressjs expressts sqlite sqlite3 ts typescript typescript-express

Last synced: 4 days ago
JSON representation

A lightweight and minimal REST API built with TypeScript, Express, and SQLite.

Host: GitHub
URL: https://github.com/basemax/simple-api-typescript
Owner: BaseMax
Created: 2025-02-10T16:20:52.000Z (5 days ago)
Default Branch: main
Last Pushed: 2025-02-10T17:32:26.000Z (5 days ago)
Last Synced: 2025-02-10T18:58:06.164Z (5 days ago)
Topics: bun, express-js, express-ts, expressjs, expressts, sqlite, sqlite3, ts, typescript, typescript-express
Language: TypeScript
Homepage:
Size: 39.1 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

# Simple API in TypeScript

A lightweight and minimal REST API built with TypeScript, Express, and SQLite.

## Features

- Express.js for handling API routes
- SQLite3 as the database (without Prisma)
- TypeScript for type safety
- Supertest and Bun.js for testing

## Installation

**Ensure you have the following installed:**

- Node.js (>=16)
- Bun (for testing, optional)

**Clone the Repository:**

```
git clone https://github.com/BaseMax/simple-api-typescript.git
cd simple-api-typescript
```

**Install Dependencies**

```
npm install
```

## Usage

**Start the Server:**

```
npm run dev
```

This will start the API on `http://localhost:3000`.

**Run Tests:**

```
bun test
```

## API Endpoints

### Create a User

POST /users

Request Body:
```
{
"name": "John Doe",
"email": "[email protected]"
}
```

### Get All Users

GET /users

### Get a User by ID

GET /users/:id

### Delete a User

DELETE /users/:id

## License

This project is licensed under the MIT License.