Template for modern SSR applications

Possibilities

• Modern JavaScript stack for services: React, Next.js
• A lot of CI checks to ensure the highest code quality that can be (Security checks, Code style fixer, static linters, DeepScan, Snyk)
• Configured testing tools: Playwright, Jest
• This template is based on bulletproof-react
• Much more!

Why you might need it

Many front-end developers need to create new projects from scratch and spend a lot of time.

We decided to simplify this exhausting process and create a public template for modern front-end applications. This template is used for all our microservices in VilnaCRM.

License

This software is distributed under the Creative Commons Zero v1.0 Universal license. Please read LICENSE for information on the software availability and distribution.

Minimal installation

You can clone this repository locally or use Github functionality "Use this template"

Install node.js 20 version or higher and pnpm

Use pnpm install for installing all dependencies and pnpm run dev for running application

Using

The list of possibilities

pnpm run dev - starts application
pnpm run build - build application
pnpm lint:next - static next lint
pnpm lint:tsc - static TypeScript lint
pnpm test:e2e - end-to-end testing
pnpm test:e2e:local - open GUI with list of end-to-end test
pnpm test:unit - unit testing
pnpm lighthouse:desktop - lighthouse desktop testing
pnpm lighthouse:mobile - lighthouse mobile tesitng

Documentation

Start reading at the GitHub wiki. If you're having trouble, head for the troubleshooting guide as it's frequently updated.

You can generate complete API-level documentation by running doc in the top-level folder, and documentation will appear in the docs folder, though you'll need to have API-Extractor installed.

If the documentation doesn't cover what you need, search the many questions on Stack Overflow, and before you ask a question, read the troubleshooting guide.

Tests

Tests

If this isn't passing, is there something you can do to help?

Security

Please disclose any vulnerabilities found responsibly – report security issues to the maintainers privately.

See SECURITY and Security advisories on GitHub.

Contributing

Please submit bug reports, suggestions, and pull requests to the GitHub issue tracker.

We're particularly interested in fixing edge cases, expanding test coverage, and updating translations.

If you found a mistake in the docs, or want to add something, go ahead and amend the wiki – anyone can edit it.

Sponsorship

Development time and resources for this repository are provided by VilnaCRM, the free and opensource CRM system.

Donations are very welcome, whether in beer 🍺, T-shirts 👕, or cold, hard cash 💰. Sponsorship through GitHub is a simple and convenient way to say "thank you" to maintainers and contributors – just click the "Sponsor" button on the project page. If your company uses this template, consider taking part in the VilnaCRM's enterprise support program.

Changelog

See changelog.