GeekyAnts/express-typescript hiện có 1.3k sao trên GitHub, viết chủ yếu bằng TypeScript. Express + TypeScript + Boilerplate for Web / API App
Tóm tắt dựng từ metadata GitHub của chính dự án — chưa có bài review TopGit. Trang sẽ tự động cập nhật khi bài review đầy đủ được xuất bản.
VÌ SAO CHƯA CÓ REVIEW
TopGit viết bài đầy đủ cho repo có nhiều sao nhất và được yêu cầu nhiều nhất. Trang này là snapshot trong thời gian chờ — xem README gốc ở tab READ ME.
Hey There! 🙌
🤾 that ⭐️ button if you like this boilerplate.
A boilerplate for Node.js App.
This boilerplate is built using Express.js web framework, and is using Typescript Lang for writing the app's logic.
It uses Node's Cluster API, this helps us to take advantage of multi-core systems & to handle the load.
For storing custom constant configurations within the process.env - DotEnv package is used.
For Database - Repo contains the use of Mongoose (ie. MongoDB object modeling for Node.js).
For Cache - Repo contains the use of memory-cache (ie. A simple in-memory cache for node.js).
For Routing - Repo contains the use of express-router & have distributed Routes into two files ie. Web Routes & API Routes.
For Route Auth Middleware - Web routes are configured with CSRF Token while the API routes are configured with JSON Web Token.
For Strategies Auth - Repo contains the use of the Passport.js. Passport.js is compatible with Express.js and is authentication middleware for Node.js.
For Logging - Repo uses custom Log class built in middlewares folder, and it creates logs file by date & removes the log files after 'X' days (You can define that 'X' in the .env file).
For Handling Exception - Repo contains two classes ie. Handler & NativeEvent.
To Log - use Log.info('Your message should go here!'). Other options for logging are Log.warn, Log.error & Log.custom.
For views - Repo contains the use of PUG template engine.
For background queues - Repo contains the use of Kue. For more details, please review the Queue class.
Contents
Global Requisites
App Structure
Install, Configure & Run
List of Routes
Screens
Global Requisites
node (>= 10.5.0)
tsc (>= 3.0.1)
typescript (>= 3.0.1)
mongoose (>= 3.6.2)
redis
App Structure
Note: I am mentioning only files/folders which you need to configure if required
Below mentioned are the steps to install, configure & run in your platform/distributions.
# Clone the repo.
git clone https://github.com/GeekyAnts/express-typescript.git;
# Goto the cloned project folder.
cd nodets;
# Without Docker
# Note: It is assumed here that you have MongoDB running in the background and that you have created the database.
# Install NPM dependencies.
# Note: You can review the list of dependencies from the below link.
# https://github.com/faizahmedfarooqui/nodets/network/dependencies
npm install;
# Edit your DotEnv file using any editor of your choice.
# Please Note: You should add all the configurations details
# or else default values will be used!
vim .env;
# Run the app
npm run dev;
# With Docker
# Note: It is assumed here that you have Docker running in the background.
# Run the app in docker as a foreground process
docker-compose up
# Run the app in docker as a background process
docker-compose up -d
List of Routes
# Web Routes:
+--------+-------------------------+
Method | URI
+--------+-------------------------+
GET | /
GET | /signup
POST | /signup
GET | /login
POST | /login
GET | /logout
GET | /account
GET | /auth/google
GET | /auth/google/callback
GET | /auth/twitter
GET | /auth/twitter/callback
GET | /status-monitor
+--------+-------------------------+
# API Routes:
+--------+-------------------------+
Method | URI
+--------+-------------------------+
POST | /api
POST | /api/auth/login
POST | /api/auth/register
POST | /api/auth/refresh-token
+--------+-------------------------+
Screens
Home / Landing Page
Note: This page has sub-sections, like about-us, contact-us & portfolio
LogIn Page
Note: LogIn with Providers
SignUp Page
Note: SignUp with Providers
Dashboard Page
With Dropdown Menu
Page Not Found Page
Note: In case the requested URI does not exist, app shows this page
Under Maintenance Page
Note: In case an error is generated, so instead of plain errors we can show the under maintenance page.
About GeekyAnts
This boilerplate is maintained by GeekyAnts,
a product development studio specializing in:
GeekyAnts/express-typescript thuộc nhóm Developer Tools trên TopGit, cùng 14 topic GitHub. Trang Trending và Topics liệt kê các repo cùng số sao và cùng ngôn ngữ để so sánh.
Đọc thêm về GeekyAnts/express-typescript ở đâu?
Trang TopGit này là một snapshot — tab "Readme" hiển thị nguyên văn README của repo (đã bỏ link, giữ ảnh). Repo GitHub ở github.com/GeekyAnts/express-typescript là nguồn chính thức.
GeekyAnts/express-typescript có phải mã nguồn mở không?
Có — GeekyAnts/express-typescript phát hành theo license MIT, nghĩa là mã nguồn mở để đọc, fork và (tùy license) tái sử dụng. Mã: github.com/GeekyAnts/express-typescript.
GeekyAnts/express-typescript có trang demo không?
Dự án có trang chủ ở https://geekyants.github.io/express-typescript/. Tab "Readme" ở trang này thường có ảnh chụp và hướng dẫn bắt đầu nhanh.
GeekyAnts/express-typescript dùng license gì?
GeekyAnts/express-typescript phát hành theo license MIT. Nên mở file LICENSE trên GitHub để xác nhận — license metadata đôi khi lệch với thực tế dự án.
GeekyAnts/express-typescript là gì?
GeekyAnts/express-typescript (GeekyAnts/express-typescript) là dự án TypeScript trên GitHub. Theo mô tả gốc: Express + TypeScript + Boilerplate for Web / API App
Vì sao GeekyAnts/express-typescript được xếp vào nhóm Developer Tools?
TopGit xếp GeekyAnts/express-typescript vào nhóm Developer Tools dựa trên GitHub topics và mô tả của repo (gắn thẻ: "boilerplate", "docker", "docker-compose"). Việc phân loại dựa trên metadata thật của repo, không phải đoán theo cảm tính biên tập.
Đọc đầy đủ README ở tab phía trên.
Vẫn đang phân vân về express-typescript?
Một cú bấm sẽ gửi câu hỏi kèm trang này cho AI — xem AI nói gì về express-typescript.