https://github.com/adityadeshlahre/websocket-quick-start
personal starter kit with WebSocket initialized and deployed to Render
https://github.com/adityadeshlahre/websocket-quick-start
expressjs nodejs reactjs starter-template websocket
Last synced: 4 months ago
JSON representation
personal starter kit with WebSocket initialized and deployed to Render
- Host: GitHub
- URL: https://github.com/adityadeshlahre/websocket-quick-start
- Owner: adityadeshlahre
- Created: 2025-05-03T18:23:25.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-05-16T11:16:50.000Z (about 1 year ago)
- Last Synced: 2025-05-16T11:36:32.753Z (about 1 year ago)
- Topics: expressjs, nodejs, reactjs, starter-template, websocket
- Language: TypeScript
- Homepage: https://websocket-quick-start-web.onrender.com
- Size: 88.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## websocket + 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.
> [WebSocket:URL]
> wss://websocket-quick-start-ws.onrender.com
### Tech Stack
- [x] React JS (Vite as initializer)
- [x] Node/Express Js
- [x] TailwindCSS
- [x] Recoil
- [x] Axios
- [x] Prisma
- [x] Zod
### Insider
```
"apps/ws" this ws(websocket) folder is initializes using npm and tsc [websocket server]
```
```
"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
- [x] ESLinting
- [x] Lint Stage
- [x] husky
- [x] Docker
- [x] CI (to build and push image also run in render)
- [x] CommitLint
- [x] centeralized ENV
- [ ] nodeSever{node dist/index.js} need to fix
- [ ] cleanup
### Getting Started
```bash
bun create next-app -e "https://github.com/adityadeshlahre/quick-start"
npx create-next-app -e "https://github.com/adityadeshlahre/quick-start"
```
OR
**Install `degit` globally**
```bash
bun i -g degit || pnpm i -g degit || yarn global add degit || npm i -g degit
```
**Create a new project from this template**
```bash
degit adityadeshlahre/quick-start
# using GH cli
gh repo create --template / --public
cd
```
**Install dependencies**
```bash
bun i || pnpm i || yarn || npm i
```
**Initialize a new git repository _(Optional)_:**
```bash
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
- [x] dev.docker-compose.yml (run this if you want to do development without and hustule in you localsetup)
- [x] build.docker-compose.yml (this is just to build image and push to docker hub )
- [x] prod.docker-compose.yml (this production build if you have vps JUST pull this tempelate from github and run this in your vps)
- [x] 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
````markdown
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)
````