cloudtasks/api repository overview

⁠Loopback API Seed

For further information and development consult Loopback Documentation⁠

⁠Features:

• Core Models
• Helper mixins
• REST and GraphQL (experimental)
• Email templating system
• Social logins with Passport
• OAuth2 authentication
• Phone mixin for "user" WIP⁠
• Two Step Authentication mixin for "user" WIP⁠
• User payment and billing system WIP⁠

• user <-> app with roles
• user with multiple emails WIP⁠
• Security with ACLs and Scopes pre configured

• Angular2 SDK generator: loopback-sdk-builder⁠
• Real-Time functionalities like PubSub, IO and the new FireLoop Module⁠. loopback-component-realtime⁠

• Tests for everything WIP⁠
• Lint configuration

• Fully stateless
• Docker based deployment

⁠How to use

git clone https://github.com/JonnyBGod/api-seed.git ./api
cd api
rm -rf .git
npm run git:setup
npm i

Now you are ready to start using it and developing

npm start

⁠Configurations

Files to take into account:

./server/config.json
./server/config.production.json
	
./server/datasources.json
./server/datasources.production.json
./server/datasources.test.json

./server/providers.json

./newrelic.js

⁠Environment Variables

• REST_API_ROOT ('/api')

• HOST ('0.0.0.0')

• PORT (54447) (80)

• URL ('http://localhost:54447/⁠') ('https://api-seed.herokuapp.com/⁠')

• CLIENT_URL ('http://localhost:3000/⁠') ('https://jonnybgod.github.io/web-seed/⁠')

• AWS_ACCESS_KEY_ID ('AKIAJPGY43MHFLHBSZ7A')

• AWS_SECRET_ACCESS_KEY ('+Ab0wAp0Tn9pXtugh6SwpOIgSgmw/QKiZgraV5Ml')

• AWS_REGION ('eu-west-1')

• S3_BUCKET ('api-seed')

• S3_ACL ('public-read')

• NEWRELIC_APP_NAME ('api-seed')

• NEWRELIC_LICENSE_KEY ('fc8201bbacbd2865d46d6a6cd53a5274b470b43d')

• NEWRELIC_LOG_LEVEL ('info')

⁠API Explorers

/explorer⁠ /slate⁠ /graphiql⁠ /visualize⁠ /modeldiagram⁠

⁠Demo

demo server⁠

/explorer⁠ /slate⁠ /graphiql⁠ /visualize⁠ /modeldiagram⁠

⁠Merge Upstream

If you followed "How to use" procedure, you can take advantage of update made in this repo

npm run git:merge:preview

this command will not do anything. You will just see what changed would do if you use the next command

npm run git:merge

Now you just have to deal with conflits...

⁠Generate Angular SDK

This project is intende for a specific structure:

• your_project_name
  • api based on this repo⁠
  • web based on web-seed⁠

npm run build:sdk:web

⁠Build Docker container for production deployment

First change the name of the container at "build:docker" script in package.json

npm run build:docker