0.5.0 • Published 3 years ago

@alexstack/universal-mean-api v0.5.0

Weekly downloads
-
License
MIT
Repository
-
Last release
3 years ago

Serverless MEAN API

  • An Universal RESTful CRUD API for dynamic multiple collections of mongodb (database tables) with Node.js and Express.js, we DO NOT need to code the CRUD route/controller for each collection/table anymore.
  • Designed to run on Serverless environment, such as AWS Lambda, Azure, Google, NetLify, Vercel
  • MEAN API stands for MongoDB(M) + Express.js(E) + Universal CRUD API(A) + Node.js(N)
  • All schemas and api routes can define in ONE file: api.config.js (No need to create mongodb collection beforehand)
  • Come with a react-admin demo
  • Support field search(=, %like%, full-text) and some json-sever standard parameters: _sort, _order, _start, _end, _limit, _like, _gte, _lte, id=1,2,3,4,5

Debug locally

  • cd universalApi
  • nodemon awsLambda.js
  • cd reactAdmin
  • npm start

AWS Lambda settings

  • Function js file: awsLambda.js

Serverless function settings for NetLify

  • Base directory: Empty(Not set)
  • Build command: npm install && cd reactAdmin && npm install && npm run build && rm -rf node_modules
  • Publish directory: reactAdmin/build
  • Functions directory: netlifyFunctions
  • Function js file: netlifyFunctions/serverlessapi.js
  • Environment variables API_BASE: .netlify/functions/serverlessapi/ DB: mongodb+srv://db-user:db-pass@cluster0.tblrm.mongodb.net/db-name?retryWrites=true&w=majority DEBUG: yes REACT_APP_MEAN_API: https://meanapi.netlify.app/.netlify/functions/serverlessapi
  • Config react-admin for API demo or admin dashboard

Vercel