Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dimaskiddo/codebase-bun-rest
Codebase for REST API in Bun using Typescript
https://github.com/dimaskiddo/codebase-bun-rest
api bun codebase rest server ts typescript
Last synced: 9 days ago
JSON representation
Codebase for REST API in Bun using Typescript
- Host: GitHub
- URL: https://github.com/dimaskiddo/codebase-bun-rest
- Owner: dimaskiddo
- Created: 2023-11-05T02:17:06.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2023-12-07T06:05:00.000Z (12 months ago)
- Last Synced: 2023-12-07T07:24:52.859Z (12 months ago)
- Topics: api, bun, codebase, rest, server, ts, typescript
- Language: TypeScript
- Homepage:
- Size: 278 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Codebase for REST API in Bun using Typescript
This codebase help a new Bun developer in developing a REST API in Bun using Typescript.
This codebase included with some pre bundle service or helper like authentication, logging, and predefined configuration.
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
See deployment for notes on how to deploy the project on a live system.
### Prerequisites
Prequisites package:
* Bun (Javascript Runtime)
Optional package:
* Docker (Application Containerization)
### Installing
Below is the instructions to make this codebase running:
* Pull the codebase from this repository
```
git clone -b master https://github.com/dimaskiddo/codebase-bun-rest.git
cd codebase-bun-rest
```
* Remove any related git configuration
```
rm -rf .git
```
* Run following command to pull dependecies package
```
bun install
```
- Until this step you already can run this code by using this command
```
bun start
```
## Running The Tests
Currently the test is not ready yet :)
## Built With
* [Bun](https://bun.sh/) - Javascript Runtime
* [Docker](https://www.docker.com/) - Application Containerization
## Authors
* **Dimas Restu Hidayanto** - *Initial Work* - [DimasKiddo](https://github.com/dimaskiddo)
See also the list of [contributors](https://github.com/dimaskiddo/codebase-bun-rest/contributors) who participated in this project
## Annotation
You can seek more information for the npm command parameters in the [package.json](https://raw.githubusercontent.com/dimaskiddo/codebase-bun-rest/master/package.json)