Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ymc-github/blog-api-express-mongoose
my blog api
https://github.com/ymc-github/blog-api-express-mongoose
api blog dkc docker express mongoose
Last synced: 8 days ago
JSON representation
my blog api
- Host: GitHub
- URL: https://github.com/ymc-github/blog-api-express-mongoose
- Owner: YMC-GitHub
- License: mit
- Created: 2019-12-24T08:28:01.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T13:09:18.000Z (almost 2 years ago)
- Last Synced: 2023-03-02T01:16:42.994Z (over 1 year ago)
- Topics: api, blog, dkc, docker, express, mongoose
- Language: JavaScript
- Homepage:
- Size: 1.05 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- License: license
Awesome Lists containing this project
README
# blog-api
## desc
my blog api with nodejs
## qucik start
```sh
# Install dependencies
npm install
# Start the api server(dev)
npm run start
# Start the api server(pro)
npm run pm2
#...
```
## add admin user
Add admin http://localhost:4000/api/backend
After the success of the administrator to add, will automatically generate the admin.
Lock file locking, if you need to continue to add, please just delete the file
note:get more details on [api-docs(todos)]().
## the project construtor
```
|--README.md #read me before
|--app.js #the app index file
|--bin #run the app index file
| |--www
|--license
|--package.json
|--server
| |--api #some api handle files
| | |--backend-article.js
| | |--backend-category.js
| | |--backend-user.js
| | |--frontend-article.js
| | |--frontend-comment.js
| | |--frontend-like.js
| | |--frontend-user.js
| | |--general.js
| |--config #some config for cunstom app
| | |--index.js
| | |--mpapp.js
| | |--secret.js
| |--middlewares #some custom middlewares files
| | |--admin.js
| | |--check.js
| | |--user.js
| |--models #some data model files
| | |--admin.js
| | |--article.js
| | |--category.js
| | |--comment.js
| | |--user.js
| |--mongoose.js # connect database
| |--routes # map the url path to handle files/functions with router
| | |--backend.js
| | |--frontend.js
| | |--index.js
| |--utils #some useful tool
|--views #some views
|--admin-add.ejs
|--favicon.ico
```
## the lifecricle of the app
- map the url path to handle files/functions with route
- connect database
```
req url->route->model->view->res uri
```
## some custom express middleware
admin:
```
// ================ admin ================
// this is a custom express middleware admin
// ================ admin ================
// task:
// check if user is admin:
// 01.need to login first
// 02.need to check the user
// if true,goto next middleware
```
user:
```
// ================ user ================
// this is a custom express middleware user
// ================ user ================
// task:
// check if user is user:
// 01.need to login first
// 02.need to check the user
// if true,goto next middleware
```
return:
```
// ================ return ================
// this is a custom express middleware return
// ================ return ================
// task:
// bind error,success function to ctx to uniform the return result
// and goto next middleware
```