https://github.com/tidbitsjs/ts-restapi
https://github.com/tidbitsjs/ts-restapi
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/tidbitsjs/ts-restapi
- Owner: TidbitsJS
- Created: 2022-04-05T18:25:49.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2022-04-10T18:12:05.000Z (about 4 years ago)
- Last Synced: 2025-02-12T21:41:48.730Z (over 1 year ago)
- Language: TypeScript
- Size: 73.2 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# TypeScript REST API
A REST API created using Node.js & TypeScript. It does all CRUD operations to manage a user database. The primary purpose of the project is to get familiarized with developing the backend with TypeScript.
### Setup
Project requirements
* git
* NodeJS
* NPM
* nodemon
**nodemon** is a tool that helps develop node. js based applications by automatically restarting the node application when file changes in the directory are detected.
To verify the installation of above, you can run this:
```shell
git --version
node --version
npm --version
nodemon --version
```
After you've made sure to have the correct things installed, you should be able to just run a few commands to get set up:
1. Clone the repo
```shell
git clone https://github.com/TidbitsJS/Ts-RestAPI.git
cd Ts-RestAPI
```
2. Install node modules
```shell
npm install
```
### Running the App
To run the app, run the command:
```shell
npm start
```
Local server will start running on the port 4040