Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/danuja01/expressjs

Last synced: 27 days ago
JSON representation

Host: GitHub
URL: https://github.com/danuja01/expressjs
Owner: danuja01
Created: 2023-05-18T04:27:31.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2023-05-18T04:27:37.000Z (over 1 year ago)
Last Synced: 2023-08-13T22:50:54.208Z (about 1 year ago)
Language: TypeScript
Size: 34.2 KB
Stars: 0
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)