https://github.com/bene/sharepass
https://github.com/bene/sharepass
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/bene/sharepass
- Owner: bene
- Created: 2023-01-10T12:02:24.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-28T15:45:31.000Z (over 3 years ago)
- Last Synced: 2025-01-07T20:12:01.086Z (over 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 1020 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# @bene/template
> Work in progress
Project template for building fullstack TypeScript applications in a monorepo.
## Components
### Apps
| Name | Description |
| ------ | -------------------------------- |
| api | Empty package folder with Prisma |
| web | React Web App (SPA) |
| mobile | ReactNative App using Expo |
### Packages
| Name | Description |
| ----- | ------------------------------------------------------------------- |
| sdk | An SDK packages which is intended to be published on npm |
| utils | Code which is used in multiple packages in the project |
| types | TypeScript types which are used in multiple packages in the project |
## Usage
### 0. Close repo
> git clone git@github.com:bene/template.git
### 1. Rename project
Replace all occurrences of `@template` with the name of the project.
### 2. Customize
Often not all of the default packages are needed.
> rm -rf apps/mobile
Or packages should have a different name
> mv packages/utils packages/shared
### 3. Update deps
The dependencies are not updated automatically and will be outdated most of the
time.
> npm outdated
### 4. Start development
To start all apps [Turborepo](https://turbo.build/) is used.
> npm run dev