Code Monkey home page Code Monkey logo

ts-rest's Introduction

TypeScript REST API

Ini adalah Project Based Learning dari Typescript berupa REST API

Project Based Learning Typescript REST api adalah sebuah proyek belajar pemrograman dengan menggunakan bahasa Typescript yang fokus pada pembuatan RESTful API. Pada proyek ini, Anda akan mempelajari cara mengembangkan aplikasi web dengan menggunakan Node.js dan Express.js, serta menggunakan database MongoDB sebagai penyimpan data.


Getting Started

Instruksi ini akan memberi Anda salinan proyek dan berjalan di mesin lokal Anda untuk tujuan pengembangan dan pengujian.

Prerequisites

Node.js v14.15.0 or later NPM v6.14.8 or later MongoDB v4.4.5 or later

Installation

Clone the repository:

git clone https://github.com/mayopi/TS-REST.git

Install dependencies:

cd TS-REST npm install

PENTING!: Buat file .env di direktori root proyek dengan konfigurasi berikut:

MONGO_URL=mongodb://{username}:{password}@{host}:{port}/{database}
PORT=3000
SECRET_ACCESS_TOKEN={random-string}

Ganti {username}, {password}, โ€‹โ€‹{host}, {port}, {database}, dan {random-string} dengan konfigurasi Anda sendiri.

Running

Untuk memulai server pengembangan, jalankan:

npm run dev

Server akan mendengarkan pada port 3000 secara default.

API Endpoints

  • Otentikasi Pengguna
  • Daftarkan Pengguna
    • POST /api/auth/register

Mendaftarkan Pengguna baru.

Parameter Type Required Description
email String Yes User Email Address
username String Yes User Name
password String Yes User Password
  • Login Pengguna
    • POST /api/auth/login

Log in menggunakan Pengguna.

Parameter Type Required Description
email String Yes User's email address.
password String Yes User's password.
  • Logout Pengguna
    • POST /api/auth/logout

Log out Pengguna saat ini.

  • Managemen Pengguna
    • Get All Users
      • GET /api/users

Mengembalikan daftar semua pengguna.

  • Dapatkan Pengguna berdasarkan Email
    • GET /api/users/:email

Mengembalikan satu pengguna dengan Email yang ditentukan.

Built With

  • Express - Web framework for Node.js
  • Mongoose - Object data modeling library for MongoDB
  • TypeScript - Typed superset of JavaScript

Authors

Mayopi - Initial work

ts-rest's People

Contributors

mayopi avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.