Repository files navigation

Support Ukraine:link

Open source web app that saves you many days of work when building your own SaaS product. The boilerplate comes with many basic SaaS features (seeFeatures below) so that you can focus on features that differentiate your product.

If you want to learn how to build this project from scratch, check out our book:https://builderbook.org/book

The open source project is located in thesaas folder. If you purchased our book, codebases for each of the book's chapters are located in thebook folder.

We've used thissaas project to build:

• Builder Book - learn how to build full-stack web apps from scratch
• SaaS Boilerplate - open source web app to build your own SaaS product
• Work in biotech - job board for biotech startup companies
• AI-cruiter - browser extension is built for recruiters managing a high volume of job applicants. AI-cruiter uses LLMs - like ChatGPT and PaLM 2 - to generate succinct and relevant summaries of your job applicants' resumes
• Async - open source urgent vs non-urgent team communication tool for small teams
• Async Labs - many custom dev projects

• APP:https://saas-app.async-await.com
• API:https://saas-api.async-await.com

Check out projects built with the help of this open source app. Feel free to add your own project by creating a pull request.

• Async: Open source web app for team communication, separate urgent vs. non-urgent conversations.
• workinbiotech.com: Work in biotech, job board for small and young biotech companies
• Retaino byEarl Lee: Save, annotate, review, and share great web content. Receive smart email digests to retain key information.
• Builder Book: Open source web app to publish documentation or books.

• Features
• Run locally
• Deploy
• Built with
• Screenshots
• Contributing
• Team
• License
• Project structure

• Server-side rendering for fast initial load and SEO.
• User authentication with Google OAuth API and Passwordless, cookie, and session.
• Production-ready Express server with compression, parser, and helmet.
• Transactional emails (AWS SES): welcome, team invitation, and payment.
• Adding email addresses to newsletter lists (Mailchimp): new users, paying users.
• File upload, load, and deletion (AWS S3) with pre-signed request for: Posts, Team Profile, and User Profile.
• Websockets with socket.io v3.
• Team creation, Team Member invitation, and settings for Team and User.
• Opinionated architecture:
  • keeping babel and webpack configurations under the hood,
  • striving to minimize number of configurations,
  • withAuth HOC to pass user prop and control user access to pages,
  • HOC extensionsMyApp andMyDocument
  • server-side rendering withMaterial-UI,
  • model-specific components in addition to common components.
• Universally-available environmental variables at runtime.
• Custom logger (configure whatnot to print in production).
• Useful components for any web app:ActiveLink,Confirm,Notifier,MenuWithLinks, and more.
• Analytics withGoogle Analytics.
• Production-ready, scalable architecture:
  • app - user-facing web app with Next/Express server, responsible for rendering pages (either client-side or server-side rendered).app sends requests via API methods toapi Express server.
  • api - server-only code, Express server, responsible for processing requests for internal and external API infrastructures.
• Subscriptions withStripe:
  • subscribe/unsubscribe Team to plan,
  • update card information,
  • verified Stripe webhook for failed payment for subscription.

• Before running, create a.env file inside theapi folder with the environmental variables as shown below. These variables are also listed in.env.example, which you can use as a template to create your own.env file inside theapi foler.

api/.env:

# Used in api/server/server.tsMONGO_URL_TEST=MONGO_URL=SESSION_NAME=SESSION_SECRET=COOKIE_DOMAIN=# Used in api/server/google.tsGOOGLE_CLIENTID=GOOGLE_CLIENTSECRET=# Used in api/server/aws-s3.ts and api/server/aws-ses.tsAWS_REGION=AWS_ACCESSKEYID=AWS_SECRETACCESSKEY=# Used in api/server/models/Invitation.ts and api/server/models/User.tsEMAIL_SUPPORT_FROM_ADDRESS=# Used in api/server/mailchimp.tsMAILCHIMP_API_KEY=MAILCHIMP_REGION=MAILCHIMP_SAAS_ALL_LIST_ID=----------# All env variables above this line are needed for successful user signup# Used in api/server/stripe.tsSTRIPE_TEST_SECRETKEY=sk_test_xxxxxxSTRIPE_LIVE_SECRETKEY=sk_live_xxxxxxSTRIPE_TEST_PLANID=plan_xxxxxxSTRIPE_LIVE_PLANID=plan_xxxxxxSTRIPE_LIVE_ENDPOINTSECRET=whsec_xxxxxx# Optionally determine the URLURL_APP="http://localhost:3000"URL_API="http://localhost:8000"PRODUCTION_URL_APP="https://saas-app.async-await.com"PRODUCTION_URL_API="https://saas-api.async-await.com"

• Your.env file filemust have values for therequired variables. To use all features and third-party integrations, also add theoptional variables.

• IMPORTANT: do not publish your actual values for environmentable variables in.env.example; this file is public and only meant to show you how your.env should look.
  

• IMPORTANT: use your values forPRODUCTION_URL_APP andPRODUCTION_URL_API. These are values for domain name that you own.

• IMPORTANT: The above environmental variables are available on the server only. You should add your.env file to.gitignore inside theapi folder so that your secret keys are not stored on a remote Github repo.

• To get value forMONGO_URL_TEST, we recommend you use afree MongoDB at MongoDB Atlas or$15/month MongoDB at Digital Ocean

• Specify your own name and secret keys for Express session:SESSION_NAME andSESSION_SECRET

• GetGOOGLE_CLIENTID andGOOGLE_CLIENTSECRET by following theofficial OAuth tutorial.
  Important: For Google OAuth app, callback URL is:http://localhost:8000/oauth2callback
  Important: You have to enable Google+ API in your Google Cloud Platform account.

• Once.env is created, you can run theapi app. Navigate to theapi folder, runyarn install to add all packages, then run the command below:

  yarn dev

• Navigate to theapp folder, runyarn to add all packages, then runyarn dev and navigate tohttp://localhost:3000:

  • A.env file in theapp folder is not required to run, but you can create one to override the default variables. The environmental variables for.env in theapp folder are shown below. You can also refer.env.example for creating your own.env file in theapp folder.
    

    NEXT_PUBLIC_STRIPE_TEST_PUBLISHABLEKEY="pk_test_xxxxxxxxxxxxxxx"  NEXT_PUBLIC_STRIPE_LIVE_PUBLISHABLEKEY="pk_live_xxxxxxxxxxxxxxx"    NEXT_PUBLIC_BUCKET_FOR_POSTS=  NEXT_PUBLIC_BUCKET_FOR_TEAM_AVATARS=  NEXT_PUBLIC_BUCKET_FOR_TEAM_LOGOS=    NEXT_PUBLIC_URL_APP="http://localhost:3000"  NEXT_PUBLIC_URL_API="http://localhost:8000"  NEXT_PUBLIC_PRODUCTION_URL_APP=  NEXT_PUBLIC_PRODUCTION_URL_API=    NEXT_PUBLIC_API_GATEWAY_ENDPOINT=  NEXT_PUBLIC_GA_MEASUREMENT_ID=

  • IMPORTANT: do not publish your actual values for environmentable variables in.env.example; this file is public and only meant to show you how your.env should look.
    

  • IMPORTANT: use your values forPRODUCTION_URL_APP andPRODUCTION_URL_API. These are values for domain name that you own.

  • To getNEXT_PUBLIC_GA_MEASUREMENT_ID, set up Google Analytics and followthese instructions to find your tracking ID.

  • To getNEXT_PUBLIC_STRIPE_TEST_PUBLISHABLEKEY, go to your Stripe dashboard, clickDevelopers, then clickAPI keys.

• For successful file uploading, make sure your buckets have proper CORS configuration. Go to your AWS account, find your bucket, go toPermissions > CORS configuration, add:

[  {    "AllowedHeaders":[      "*"    ],    "AllowedMethods":[      "PUT",      "POST",      "GET",      "HEAD",      "DELETE"    ],    "AllowedOrigins":[      "http://localhost:3000",      "https://saas-app.async-await.com"    ],    "ExposeHeaders":[      "ETag",      "x-amz-meta-custom-header"    ]  }]

• Make sure to update allowed origin with your actual values forNEXT_PUBLIC_URL_APP andNEXT_PUBLIC_PRODUCTION_URL_APP.

• Once.env is created, you can run theapp app. Navigate to theapp folder, runyarn install to add all packages, then run the command below:

  yarn dev

In lambda directory we are symlinking api directory. You can run symlink command in lambda folder as mentioned below:

bash symlink ../api

We give detailed instructions inside Chapter 9 and 10 of our SaaS Boilerplate book:https://builderbook.org/book

• React
• Material-UI
• Next
• MobX
• Express
• Mongoose
• MongoDB
• Typescript

For more detail, checkpackage.json files in bothapp andapi folders and project's root.

To customize styles, checkthis guide.

Google or passwordless login:

Dropdown menu for settings:

Personal settings:

Team settings:

Creating a Discussion:

Writing a Post, Markdown vs. HTML view:

Discussion between team members:

Billing settings:

Purchasing a subscription:

Payment history:

Want to support this project? Consider buying ourbooks.

• Kelly Burke
• Timur Zhiyentayev

You can contact us atteam@async-labs.com.

If you are interested in working with us, check outAsync Labs.

All code in this repository is provided under theMIT License.

├── .elasticbeanstalk│   └── config.yml├── .github│   └── FUNDING.yml├── .vscode│   ├── extensions.json│   ├── launch.json│   └── settings.json├── api│   ├── .elasticbeanstalk│   │   └── config.yml│   ├── server│   │   ├── api│   │   │   ├── index.ts│   │   │   ├── public.ts│   │   │   ├── team-leader.ts│   │   │   └── team-member.ts│   │   ├── models│   │   │   ├── Discussion.ts│   │   │   ├── EmailTemplate.ts│   │   │   ├── Invitation.ts│   │   │   ├── Post.ts│   │   │   ├── Team.ts│   │   │   └── User.ts│   │   ├── utils│   │   │   ├── slugify.ts│   │   │   └── sum.ts│   │   ├── aws-s3.ts│   │   ├── aws-ses.ts│   │   ├── google-auth.ts│   │   ├── logger.ts│   │   ├── mailchimp.ts│   │   ├── passwordless-auth.ts│   │   ├── passwordless-token-mongostore.ts│   │   ├── server.ts│   │   ├── sockets.ts│   │   └── stripe.ts│   ├── static│   │   └── robots.txt│   ├── test/server/utils│   │   ├── slugify.test.ts│   │   └── sum.test.ts│   ├── .eslintignore│   ├── .eslintrc.js│   ├── .gitignore│   ├── package.json│   ├── tsconfig.json│   ├── tsconfig.server.json│   └── yarn.lock├── app│   ├── .elasticbeanstalk│   │   └── config.yml│   ├── components│   │   ├── common│   │   │   ├── Confirmer.tsx│   │   │   ├── LoginButton.tsx│   │   │   ├── MemberChooser.tsx│   │   │   ├── MenuWithLinks.tsx│   │   │   ├── MenuWithMenuItems.tsx│   │   │   └── Notifier.tsx│   │   ├── discussions│   │   │   ├── CreateDiscussionForm.tsx│   │   │   ├── DiscussionActionMenu.tsx│   │   │   ├── DiscussionList.tsx│   │   │   ├── DiscussionListItem.tsx│   │   │   └── EditDiscussionForm.tsx│   │   ├── layout│   │   │   ├── index.tsx│   │   ├── posts│   │   │   ├── PostContent.tsx│   │   │   ├── PostDetail.tsx│   │   │   ├── PostEditor.tsx│   │   │   └── PostForm.tsx│   │   ├── teams│   │   │   └── InviteMember.tsx│   ├── lib│   │   ├── api│   │   │   ├── makeQueryString.ts│   │   │   ├── public.ts│   │   │   ├── sendRequestAndGetResponse.ts│   │   │   ├── team-leader.ts│   │   │   └── team-member.ts│   │   ├── store│   │   │   ├── discussion.ts│   │   │   ├── index.ts│   │   │   ├── invitation.ts│   │   │   ├── post.ts│   │   │   ├── team.ts│   │   │   └── user.ts│   │   ├── confirm.ts│   │   ├── isMobile.ts│   │   ├── notify.ts│   │   ├── resizeImage.ts│   │   ├── sharedStyles.ts│   │   ├── theme.ts│   │   └── withAuth.tsx│   ├── pages│   │   ├── _app.tsx│   │   ├── _document.tsx│   │   ├── billing.tsx│   │   ├── create-team.tsx│   │   ├── discussion.tsx│   │   ├── invitation.tsx│   │   ├── login-cached.tsx│   │   ├── login.tsx│   │   ├── team-settings.tsx│   │   └── your-settings.tsx│   ├── public│   │   └── pepe.jpg│   ├── server│   │   ├── robots.txt│   │   ├── routesWithCache.ts│   │   ├── server.ts│   │   └── setupSitemapAndRobots.ts│   ├── .babelrc│   ├── .eslintignore│   ├── .eslintrc.js│   ├── .gitignore│   ├── next.env.d.ts│   ├── next.config.js│   ├── package.json│   ├── tsconfig.json│   ├── tsconfig.server.json│   └── yarn.lock├── book├── lambda│   ├── .estlintignore│   ├── .eslintrc.js│   ├── .gitignore│   ├── api│   ├── handler.ts│   ├── package.json│   ├── serverless.yml│   ├── tsconfig.json│   └── yarn.lock├── .gitignore├── LICENSE.md├── README.md├── package.json├── yarn.lock