Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/luanroger/electric-drizzle
shadcn-ui and Drizzle ORM with Electron. Based on electron-shadcn
https://github.com/luanroger/electric-drizzle
crud demo drizzle-orm electron react shadcn-ui tailwindcss template web
Last synced: about 10 hours ago
JSON representation
shadcn-ui and Drizzle ORM with Electron. Based on electron-shadcn
- Host: GitHub
- URL: https://github.com/luanroger/electric-drizzle
- Owner: LuanRoger
- License: mit
- Created: 2024-07-21T12:13:06.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-07-22T13:45:01.000Z (4 months ago)
- Last Synced: 2024-07-22T22:42:45.451Z (4 months ago)
- Topics: crud, demo, drizzle-orm, electron, react, shadcn-ui, tailwindcss, template, web
- Language: TypeScript
- Homepage:
- Size: 891 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# electric-drizzle
An Electron app to showcase the use of the [`drizzle`](https://orm.drizzle.team) library using the [electron-shadcn](https://github.com/LuanRoger/electron-shadcn) template as base.
> [!WARNING]
> This project is just for demo purposes, it will not be actively maintained.
## How to run
### Pre-requisites
- Node.js
- NPM
- PostgreSQL instance running
It's recomended to use Docker to run the PostgreSQL instance. You can use the following command to start a PostgreSQL instance:
```bash
docker run --name electric-drizzle-db -p 5432:5432 -d -e POSTGRES_USER=admin -e POSTGRES_PASSWORD=admin postgres
```
### Steps
1. Clone this repository
2. Install dependencies
```bash
npm install
```
3. Update the database URL:
In the [`db_consts.ts`](https://github.com/LuanRoger/electric-drizzle/blob/main/src/lib/db/db_consts.ts) file, update the `dbUrl` constant with the URL of your PostgreSQL instance.
4. Push the schemas to the database
```bash
npm run db:push
```
5. Run the app
```bash
npm run start
```
## License
This project is under the MIT license. Check the [LICENSE](https://github.com/LuanRoger/electric-drizzle/blob/main/LICENSE) for more information.