Repository files navigation

Ever® API Starter Kit™ - Open-Source Starter Kit / Boilerplate for Multi-Tenant / SaaS APIs

• NestJs /CQRS.
• GraphQL & REST APIs.
• TypeORM.
• PostgreSQL /SQLite /SQL.js.
• Docker / Kubernetes.
• Supertokens Auth.

0. Clone repo

1. Install packages

$ yarn install

2. Create local PostgreSQL DB calledever_api_starter_kit

3. Run following command:

$ yarn start

Then browsehttp://localhost:3005

Note: GraphQL Playground available athttp://localhost:3005/graphql

Note: at this moment may not work, WIP.

$ yarn build$ yarn sls:start

Then browsehttp://localhost:3005/local

Note: GraphQL Playground available athttp://localhost:3005/local/graphql

NOTE: WIP, not working well yet with serverless!

$ yarn prestart:prod&& sls deploy

$ yarn ts-node src/swagger.ts

Then browsehttp://localhost:3006/api

To generate GraphQL Client SDK (usinggraphql-code-generator), please run following command:

$ yarn generate

Generated SDK available at./generated/sdk folder and generated Schemas available at./generated/schemas folder.

• SeeCREDITS.md file for lists of libraries and software used and/or included in the Starter Kit, information about licenses, and other relevant details.

• Ever.co Website Contact Us page
• For business inquiries:mailto:ever@ever.co
• Please report security vulnerabilities tomailto:security@ever.co

Ever® API Starter Kit™ follows good security practices, but 100% security cannot be guaranteed in any software!Ever® API Starter Kit™ is provided AS IS without any warranty. Use at your own risk!See more details in theLICENSE.

In a production setup, all client-side to server-side (backend, APIs) communications should be encrypted using HTTPS/WSS/SSL (REST APIs, GraphQL endpoint, Socket.io WebSockets, etc.).

If you discover any issue regarding security, please disclose the information responsibly by sending an email tomailto:security@ever.co and not by creating a GitHub issue.

MIT

Ever® is a registered trademark ofEver Co. LTD.Ever® API Starter Kit™,Ever® Web App Starter Kit™,Ever® Demand™,Ever® Teams™,Ever® Gauzy™,Ever® Gauzy AI™,Ever® OpenSaaS™ are all trademarks ofEver Co. LTD.

The trademarks may only be used with the written permission of Ever Co. LTD. and may not be used to promote or otherwise market competitive products or services.

All other brand and product names are trademarks, registered trademarks or service marks of their respective holders.