Giter Club home page Giter Club logo

nameless-fullstack-boilerplate's Introduction

Nameless logo

Nameless Fullstack Starter Kit

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

License GitHub Actions Codecov branch Code Style Conventional Commits Dependencies

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

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

Run apps on Docker

In the root folder, just run:
pnpm dock

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

nameless-fullstack-boilerplate's People

Contributors

seahindeniz avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.