https://github.com/prabin-acharya/express-server

https://github.com/prabin-acharya/express-server

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/prabin-acharya/express-server
• Owner: prabin-acharya
• Created: 2023-09-14T02:44:43.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-09-14T02:44:44.000Z (over 1 year ago)
• Last Synced: 2025-02-09T19:43:40.492Z (3 months ago)
• Language: TypeScript
• Size: 34.2 KB
• Stars: 0
• Watchers: 2
• 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)