Skip to content
/ quick-start Public template

This is personal quick-start template using React.Js and Express framework.

Notifications You must be signed in to change notification settings

adityadeshlahre/quick-start

Repository files navigation

quick ts starter

This is my personal prefered stack for for starting simple full stack projects in one go. Initalized with turborepo in furhter i have added all the stacks along the way.

Important

This is using pnpm as package manager.

Tech Stack

  • React JS (Vite as initializer)
  • Node/Express Js
  • TailwindCSS
  • Recoil
  • Axios
  • Prisma
  • Zod

Insider

"apps/web" this web(react app) folder is initializes using VITE [backedn]
"apps/server" this server(node app) folder is initializes using VITE [frontend]
packages{folder}
    | ui{reusable frontend componenets}
    | types{types to use in both frontend and backend}
    | db{prisma schema is here and singaltion connection client is init}

To-Do Lits

  • ESLinting
  • Lint Stage
  • husky
  • Docker
  • CI (to build and push image also run in render)
  • CommitLint
  • centeralized ENV
  • nodeSever{node dist/index.js} need to fix
  • cleanup

Getting Started

bun create next-app -e "https://github.com/adityadeshlahre/quick-start" <project-name>

npx create-next-app -e "https://github.com/adityadeshlahre/quick-start" <project-name>

OR

Install degit globally

bun i -g degit || pnpm i -g degit || yarn global add degit || npm i -g degit

Create a new project from this template

degit adityadeshlahre/quick-start <project-name>
# using GH cli
gh repo create <project-name> --template <adityadeshlahre>/<quick-start> --public

cd <project-name>

Install dependencies

bun i || pnpm i || yarn || npm i

Initialize a new git repository (Optional):

git init
git add .
git commit --no-verify -m "init"

After Installation Checklist

  • Update package.json with your project details.
  • Update README.md with your project details.
  • Update LICENSE with your name and year.

Docker Infos

  • dev.docker-compose.yml (run this if you want to do development without and hustule in you localsetup)
  • build.docker-compose.yml (this is just to build image and push to docker hub )
  • prod.docker-compose.yml (this production build if you have vps JUST pull this tempelate from github and run this in your vps)
  • docker-compose.yml (this is top level docker file which will build full application image [no use as of now])

Don't know why i have created this much docker files

ENV's

Note

if you are deploying VPS or RENDER make sure set below variables

  • DATABASE_URL="" //any postgress database
  • PORT=3000
  • UI_PORT=5173
  • SERVER_URL="" //put your render server url

Top Level nginx file added

  • top level testing script

Thank You

Turborepo starter
This is an official starter Turborepo.

## Using this example

Run the following command:

```sh
npx create-turbo@latest
```

## What's inside?

This Turborepo includes the following packages/apps:

### Apps and Packages

- `docs`: a [Next.js](https://nextjs.org/) app
- `web`: another [Next.js](https://nextjs.org/) app
- `@repo/ui`: a stub React component library shared by both `web` and `docs` applications
- `@repo/eslint-config`: `eslint` configurations (includes `eslint-config-next` and `eslint-config-prettier`)
- `@repo/typescript-config`: `tsconfig.json`s used throughout the monorepo

Each package/app is 100% [TypeScript](https://www.typescriptlang.org/).

### Utilities

This Turborepo has some additional tools already setup for you:

- [TypeScript](https://www.typescriptlang.org/) for static type checking
- [ESLint](https://eslint.org/) for code linting
- [Prettier](https://prettier.io) for code formatting

### Build

To build all apps and packages, run the following command:

```
cd my-turborepo
pnpm build
```

### Develop

To develop all apps and packages, run the following command:

```
cd my-turborepo
pnpm dev
```

### Remote Caching

Turborepo can use a technique known as [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching) to share cache artifacts across machines, enabling you to share build caches with your team and CI/CD pipelines.

By default, Turborepo will cache locally. To enable Remote Caching you will need an account with Vercel. If you don't have an account you can [create one](https://vercel.com/signup), then enter the following commands:

```
cd my-turborepo
npx turbo login
```

This will authenticate the Turborepo CLI with your [Vercel account](https://vercel.com/docs/concepts/personal-accounts/overview).

Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your Turborepo:

```
npx turbo link
```

## Useful Links

Learn more about the power of Turborepo:

- [Tasks](https://turbo.build/repo/docs/core-concepts/monorepos/running-tasks)
- [Caching](https://turbo.build/repo/docs/core-concepts/caching)
- [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching)
- [Filtering](https://turbo.build/repo/docs/core-concepts/monorepos/filtering)
- [Configuration Options](https://turbo.build/repo/docs/reference/configuration)
- [CLI Usage](https://turbo.build/repo/docs/reference/command-line-reference)