rest-api-node-typescript

(★ 468)

Building RESTful Web APIs with Node.js, Express, MongoDB and TypeScript

File Explorer

Download Latest Version (.zip)

- FUNDING.yml
- settings.json
- cert.pem
- key.pem
- - cannot-get-data-with-http.png
  - cannot-get-data-without-key.png
  - cannot-get-data-without-login.png
  - cover.png
  - create-first-contact.png
  - create-mongodb-account.png
  - delete-a-contact.png
  - get-all-contacts.png
  - get-contact-by-id.png
  - get-data-over-https.png
  - get-data-with-key.png
  - get-root-request.png
  - login-mongodb.png
  - mongo-windows.png
  - mongodb-compass.png
  - run-dev-server.png
  - unique-key.png
  - update-existing-contact.png
- conf.py
- connect-web-apis-to-MongoDB.rst
- implement-routing-and-crud.rst
- index.rst
- introduction.rst
- make.bat
- Makefile
- security-for-our-web-apis.rst
- setting-up-project.rst
- using-controller-and-model.rst
- - crmController.ts
- - crmModel.ts
- - crmRoutes.ts
- app.ts
- server.ts
- static.txt
.gitignore
package-lock.json
package.json
README.md
requirements.txt
tsconfig.json

# Installation Guide

1. Get the code

git clone https://github.com/dalenguyen/rest-api-node-typescript

Downloads the entire project code from GitHub to your computer.

cd rest-api-node-typescript

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended

Prerequisites

Node.js Node.js must be installed to use npm.

npm install -g typescript ts-node

Installs the package published on the npm registry globally — no need to clone the source.

✅ After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Node.js

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install -g typescript ts-node

Installs the package published on the npm registry globally — no need to clone the source.

npm install

Downloads and installs the libraries listed in package.json.

npm run dev

Starts the development/run server.

npm run prod

Type this command into your terminal and run it.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

4. Python

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.

pip install -r requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

python <실행할 파일명>.py # README에서 정확한 실행 파일명을 확인하세요

Runs the Python script (or module).

✅ If it runs without errors and prints output in the terminal, it worked.