Jianshu

A simple application demonstrating Angular (SPA, SSR) the basic usage of permissions with NestJS (JWT, Passport, Github, User, Group, Permission) based on jianshu template.

Related Technology

@nrwl/nx - Nx is an open platform with plugins for many modern tools and frameworks.
NestJS - a JS backend framework providing architecture out of the box with a syntax similar to Angular
Angular - a JS frontend framework created by Google
Angular Universal - a JS frontend framework created by Google
Material-ui - Material Design components for Angular
TypeScript - reactive extensions for JavaScript
RxJS - superset of JS which compiles to JS, providing compile-time type checking
MongoDB - a NoSQL database
Mongoose - MongoDB object modeling designed to work in an asynchronous environment
TypeORM - ORM for TypeScript and JavaScript (ES7, ES6, ES5). Supports MySQL, PostgreSQL, MariaDB, SQLite, MS SQL Server, Oracle, WebSQL databases.
Redis - Redis is an open source (BSD licensed), in-memory data structure store, used as a database, cache, and message broker.
Ioredis - A robust, performance-focused and full-featured Redis client for Node.js.
Passport - a popular library used to implement JavaScript authentication
JWT - JSON Web Token (JWT) is a compact URL-safe means of representing claims to be transferred between two parties.
Docker - Complete flexibility to run any Docker commands. Ship Better Code, Faster.

Features

Use the Mongoose(Typegoose) connect MongoDB
Use the Ioredis connect Redis
Use JWT for authentication
Support github authentication login
Super easy to install and start using the full-featured controllers and services
DB and service agnostic extendable CRUD controllers
Reach query parsing with filtering, pagination, sorting, relations, nested relations, cache, etc.
Framework agnostic package with query builder for a frontend usage
Query, path params and DTO validation included
Overriding controller methods with ease
Tiny config (including globally)
Additional helper decorators
Swagger documentation
Support Angular server rendering
Support Angular responsive presentation
Support Domain-Driven Design

Running the project

These instructions should be sufficient for one to get the project going on their local machine

Installing core dependencies

make sure you have node.js installed version 12.13+

Local Installing DB dependencies

make sure you have MongoDB installed version 3.4+
make sure you have Redis installed version 3.2+

Docker Installing DB dependencies

make sure you have Docker

Cloning the github repository

To clone the project, run

git clone https://github.com/jiayisheji/jianshu.git

Installing the dependencies

To install the dependencies after you've cloned the project, go to its root folder and run

cd jianshu && npm install

Setting environment variables

cp .env.example  .env

Modify the corresponding values as required

Starting the MongoDB and Redis

Once you start the database application, you are ready to run the server

Boot according to your system

Notice that the server uses MongoDB and Redis so we need to have a MongoDB and Redis instance running so the server can connect to it。

If you use Docker:

docker-compose up -d

Alternative commands

If you need to work on the frontend and backend parts at the same time, you can run

npm start

Then, you can go to the Angular dev server at port 4200 and test server requests (to port 3000), we got a proxy to the backend

If you only need to work on the frontend, you can run

npm run start client

Alternatively, if you only need to work on the backend, you can run

npm run start server

Keeping in mind that you need to have the Angular app built and a MongoDB and Redis connection established

Documentation

Support

Any support is welcome. At least you can give us a star ⭐

Browser Support

Chrome	Firefox	IE / Edge	Safari	Opera
last 2 versions	last 2 versions	IE11, Edge	last 2 versions	last 2 versions

License

MIT

jiayisheji/jianshu

jiayisheji

Reviews

Repository Details