Nameless Fullstack Starter Kit

A rich, full-stack boilerplate, built in TypeScript.

Ingredients 👨‍🍳

Project's stack list is divided into 3 lists

Common

• 👨‍💼 Package Manager: PNPM
• 🔏 Type system: TypeScript
• 🧪 Test Runner: Jest
• 📈 Coverage reports: Covecov
• 👕 Linter: ESLint
• 💄 Formatter: Prettier
• 🚢 Deployment: Docker
• 📦 Continuous Integration: GitHub Actions
• 🔱 Reverse Proxy Server: NGINX

Backend

• ⏱ Runtime: Node.js
• 🖥 GraphQL, REST API and WebSocket Framework: Fastify
• 🔀 Live communication: WebSocket
• 🗃️ Database: MongoDB
• 🗃️ Database framework: Mongoose
• 📝 REST API Documentation: Swagger

Frontend

• 🖼 UI Framework: React
• 🎨 CSS Framework: Tailwind
• 📝 UI Documentation: Storybook
• 🔨 Bundler: Webpack
• 👕 Style Linter: Stylelint

Requirements

1. Node.js >= 12.22.0
2. Docker

Before getting started, make sure that Docker (Desktop) is running if you want to work locally, otherwise commands may fail, etc.

Getting started

1. Use this repository as template or create a new repository by cloning
2. Visit Codecov and register your repo
3. Head to the repository Settings > Secrets for registering your Codecov token
4. Add a new secret: CODECOV_TOKEN

Run apps locally

1. Clone or use this repository as template
2. Install pnpm (for obvious reasons):
   npm install -g pnpm
3. Install packages:
   pnpm i
4. Run apps:
   pnpm dev
   • Backend server will run at http://localhost:3000/
   • Frontend server will run at http://localhost:3001/

Run apps on Docker

In the root folder, just run:
pnpm dock

• Backend server will run at http://api.nameless.local/
• Frontend server will run at http://nameless.local/
• Storybook server will run at http://storybook.nameless.local/

Make sure to add the following host-names to the host file to imitate the domain names (How to edit)
127.0.0.1 nameless.local
127.0.0.1 api.nameless.local
127.0.0.1 storybook.nameless.local

Linting

Run ESLint with Prettier for static analysis and applying consistent code formatting:
pnpm lint

Testing

This project consists of integration tests and unit tests upon the necessity of requirements Run Jest for running tests:
pnpm test