Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jiayisheji/jianshu
仿简书nx+nodejs+nestjs6+express+mongodb+angular8+爬虫
https://github.com/jiayisheji/jianshu
angular api app cqrs crud ddd express jwt mongodb mongoose nestjs nodejs nx passport redis restful-api rxjs swagger typescript
Last synced: about 13 hours ago
JSON representation
仿简书nx+nodejs+nestjs6+express+mongodb+angular8+爬虫
- Host: GitHub
- URL: https://github.com/jiayisheji/jianshu
- Owner: jiayisheji
- Created: 2017-02-06T12:36:09.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-24T09:27:26.000Z (over 1 year ago)
- Last Synced: 2024-09-21T18:07:02.978Z (4 days ago)
- Topics: angular, api, app, cqrs, crud, ddd, express, jwt, mongodb, mongoose, nestjs, nodejs, nx, passport, redis, restful-api, rxjs, swagger, typescript
- Language: TypeScript
- Homepage:
- Size: 95.4 MB
- Stars: 308
- Watchers: 36
- Forks: 77
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Jianshu
A simple application demonstrating [Angular](https://github.com/angular/angular) (SPA, SSR) the basic usage of permissions with [NestJS](https://github.com/nestjs/nest) (JWT, Passport, Github, User, Group, Permission) based on [jianshu](https://www.jianshu.com) template.
## Related Technology
- [@nrwl/nx](https://github.com/nrwl/nx) - Nx is an open platform with plugins for many modern tools and frameworks.
- [NestJS](https://github.com/nestjs/nest) - a JS backend framework providing architecture out of the box with a syntax similar to Angular
- [Angular](https://github.com/angular/angular) - a JS frontend framework created by Google
- [Angular Universal](https://github.com/angular/universal) - a JS frontend framework created by Google
- [Material-ui](https://material.angular.io/) - Material Design components for Angular
- [TypeScript](https://github.com/Microsoft/TypeScript) - reactive extensions for JavaScript
- [RxJS](https://github.com/Reactive-Extensions/RxJS) - superset of JS which compiles to JS, providing compile-time type checking
- [MongoDB](https://github.com/mongodb/mongo) - a NoSQL database
- [Mongoose](https://github.com/Automattic/mongoose) - MongoDB object modeling designed to work in an asynchronous environment
- [TypeORM](https://github.com/typeorm/typeorm) - ORM for TypeScript and JavaScript (ES7, ES6, ES5). Supports MySQL, PostgreSQL, MariaDB, SQLite, MS SQL Server, Oracle, WebSQL databases.
- [Redis](https://redis.io) - Redis is an open source (BSD licensed), in-memory data structure store, used as a database, cache, and message broker.
- [Ioredis](https://github.com/luin/ioredis) - A robust, performance-focused and full-featured Redis client for Node.js.
- [Passport](https://github.com/jaredhanson/passport) - a popular library used to implement JavaScript authentication
- [JWT](https://jwt.io) - JSON Web Token (JWT) is a compact URL-safe means of representing claims to be transferred between two parties.
- [Docker](https://www.docker.com) - 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](https://nodejs.org/en/download/) installed version 12.13+
#### Local Installing DB dependencies
- make sure you have [MongoDB](https://www.mongodb.com/) installed version 3.4+
- make sure you have [Redis](https://redis.io/download) installed version 3.2+
#### Docker Installing DB dependencies
- make sure you have [Docker](https://www.docker.com/products/docker-desktop)
### Cloning the github repository
To clone the project, run
```bash
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
```bash
cd jianshu && npm install
```
### Setting environment variables
```bash
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:
```bash
docker-compose up -d
```
### Alternative commands
If you need to work on the frontend and backend parts at the same time, you can run
```bash
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
```bash
npm run start client
```
Alternatively, if you only need to work on the backend, you can run
```bash
npm run start server
```
Keeping in mind that you need to have the Angular app built and a MongoDB and Redis connection established
## Documentation
- [Angular Docs](https://angular.io/docs)
- [NestJS Docs](https://docs.nestjs.com)
- [Typescript Docs](http://www.typescriptlang.org/)
- [Rxjs Docs](https://rxjs.dev/api)
- [Mongoose Docs](https://mongoosejs.com/)
- [Typegoose Docs](https://typegoose.github.io/typegoose/)
- [Ioredis Docs](https://github.com/luin/ioredis/blob/master/API.md)
- [Graphql Docs](https://graphql.org/)
- [Passport Docs](http://www.passportjs.org/)
- [JWT Docs](https://jwt.io/)
- [Tutorial Docs](docs/README.md)
## Support
Any support is welcome. At least you can give us a star :star:
## Browser Support
| [
](http://godban.github.io/browsers-support-badges/)
Chrome | [
](http://godban.github.io/browsers-support-badges/)
Firefox | [
](http://godban.github.io/browsers-support-badges/)
IE / Edge | [
](http://godban.github.io/browsers-support-badges/)
Safari | [
](http://godban.github.io/browsers-support-badges/)
Opera |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| last 2 versions | last 2 versions | IE11, Edge | last 2 versions | last 2 versions |
## License
[MIT](LICENSE)