Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/yogasakti/api-wrapper

Last synced: about 1 month ago
JSON representation

Host: GitHub
URL: https://github.com/yogasakti/api-wrapper
Owner: YogaSakti
Created: 2023-05-31T05:41:09.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2023-11-06T08:19:01.000Z (about 1 year ago)
Last Synced: 2023-11-06T09:31:01.003Z (about 1 year ago)
Language: TypeScript
Size: 316 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        # ExpressJS API Example

This example starts an [ExpressJS](https://expressjs.com/) server written in [TypeScript](https://www.typescriptlang.org/).

[![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/n_2mnn?referralCode=matt)

## ✨ Features

- Express

- TypeScript

## 💁‍♀️ How to use

- Install dependencies `yarn`

- Connect to your Railway project `railway link`

- Start the development server `railway run yarn dev`

## 📝 Notes

The server started simply returns a healthcheck `status: "ok"` payload in JSON. The server code is located in `src/index.ts`.

A versioned API route is available in `src/api.ts` and example function `hello` at `/api/v1/hello`.

## 👏 Thanks

- [Faraz Patankar](https://github.com/FarazPatankar) / Railway team for the [original template](https://github.com/railwayapp-templates/expressjs)