Skip to content

Repository files navigation

Nest Logo

A progressive Node.js framework for building efficient and scalable server-side applications.

NPM Version Package License NPM Downloads CircleCI Discord Backers on Open Collective Sponsors on Open Collective Donate us Support us Follow us on Twitter

Description

Nest framework TypeScript starter repository.

Project setup

$ npm install

Stripe setup

The payments module reads its config from environment variables on boot. The process fails fast at startup if any required key is missing — there is no silent degradation at request time. Copy .env.example to .env and fill each value:

Env var Where to get it
STRIPE_SECRET_KEY Stripe Dashboard → Developers → API keys (use sk_test_… outside prod).
STRIPE_WEBHOOK_SECRET Webhook endpoint signing secret. With Stripe CLI: stripe listen --forward-to localhost:3001/webhooks/stripe prints it as whsec_…. In prod, copy from the dashboard's webhook detail page.
STRIPE_PRICE_MONTHLY One product (e.g. "Barbershop Client Subscription") with two recurring prices. Monthly $0.99 → copy its price_… ID here.
STRIPE_PRICE_YEARLY Same product's yearly $9.99 price → copy its price_… ID here.
STRIPE_CONNECT_CLIENT_ID Stripe Connect settings → ca_… Connect client ID. Required for boot validation; not used at runtime (we use Express accounts).
APP_URL_CLIENT Public URL of the client app — used by future redirect flows.
APP_URL_BARBER Public URL of the barber app — used as the base for /connect/return and /connect/refresh redirects from Stripe onboarding.

In the Stripe dashboard, also create one webhook endpoint pointing at POST {API_URL}/webhooks/stripe, subscribed to:

customer.subscription.created
customer.subscription.updated
customer.subscription.deleted
invoice.payment_succeeded
invoice.payment_failed
payment_intent.succeeded
payment_intent.payment_failed
account.updated
payment_method.detached

Locally, the easiest way to develop is to forward events with the Stripe CLI:

stripe login
stripe listen --forward-to localhost:3001/webhooks/stripe
# copy the printed whsec_… into STRIPE_WEBHOOK_SECRET
npm run start:dev

Compile and run the project

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Run tests

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Deployment

When you're ready to deploy your NestJS application to production, there are some key steps you can take to ensure it runs as efficiently as possible. Check out the deployment documentation for more information.

If you are looking for a cloud-based platform to deploy your NestJS application, check out Mau, our official platform for deploying NestJS applications on AWS. Mau makes deployment straightforward and fast, requiring just a few simple steps:

$ npm install -g @nestjs/mau
$ mau deploy

With Mau, you can deploy your application in just a few clicks, allowing you to focus on building features rather than managing infrastructure.

Resources

Check out a few resources that may come in handy when working with NestJS:

  • Visit the NestJS Documentation to learn more about the framework.
  • For questions and support, please visit our Discord channel.
  • To dive deeper and get more hands-on experience, check out our official video courses.
  • Deploy your application to AWS with the help of NestJS Mau in just a few clicks.
  • Visualize your application graph and interact with the NestJS application in real-time using NestJS Devtools.
  • Need help with your project (part-time to full-time)? Check out our official enterprise support.
  • To stay in the loop and get updates, follow us on X and LinkedIn.
  • Looking for a job, or have a job to offer? Check out our official Jobs board.

Support

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.

Stay in touch

License

Nest is MIT licensed.

About

No description, website, or topics provided.

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages