https://github.com/oardi/expressjs-typescript-starter

Expressjs Typescript Starter with simple CRUD based on mocked data
https://github.com/oardi/expressjs-typescript-starter

crud expressjs helmet nodemon typescript

Last synced: about 1 month ago
JSON representation

Expressjs Typescript Starter with simple CRUD based on mocked data

• Host: GitHub
• URL: https://github.com/oardi/expressjs-typescript-starter
• Owner: oardi
• Created: 2020-12-04T14:11:12.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2024-02-10T11:28:06.000Z (11 months ago)
• Last Synced: 2024-02-10T12:28:48.357Z (11 months ago)
• Topics: crud, expressjs, helmet, nodemon, typescript
• Language: TypeScript
• Homepage:
• Size: 85 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# Expressjs Typescript Starter

This is a very simple ExpressJs Backend using Typescript and Nodemon to serve some basic CRUD Functions.

It uses temporary data placed in the file "src/data/posts.ts".

All operations are done on the temporary data.

Once you restart the backend, all operations are gone.

No Database is used as it would make this simple starter project more complicated.

## API Endpoints

-   GET "/" - returning the string 'hello expressjs typescript starter'

-   GET "/posts" - returning all posts

-   GET "/posts/:id" - returning a single post by ID

-   POST "/posts" - adding a new post by Post Data

-   PUT "/posts/:id" - updating an existing post by ID and Post Data

-   DELETE "/posts/:id" - deleting a single post by ID

## Start the Dev Server

run the following command in a terminal

`npm start`

this will make run the Dev Server listening on Port 8080

## Test Dev Server

Use Postman or any other Client to test if your Dev Server is running by calling an Endpoint like

`http://localhost:8080`

this will call the first GET Call listet above - which will return 'hello expressjs typescript starter'

## Postman

To test this API without a Frontend Application, simply import the collection and environment into Postman.