-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
updated README with proper instructions moved the drizzle schema file to `src/lib`
- Loading branch information
Showing
5 changed files
with
87 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,69 @@ | ||
# BSE 205 - Elective Project | ||
<h1>BSE 205 - Elective Project</h1> | ||
|
||
- [The Stack](#the-stack) | ||
- [Building](#building) | ||
- [Project Structure](#project-structure) | ||
|
||
# The Stack | ||
|
||
I was aiming for a "*soydev*" stack, I think I've got it. | ||
|
||
- [SvelteKit](https://kit.svelte.dev) | ||
- [DrizzleORM](https://orm.drizzle.team/) | ||
- [Bun SQLite](https://bun.sh/docs/api/sqlite) | ||
- [@shadcn/ui (svelte port)](https://www.shadcn-svelte.com/) | ||
|
||
# Building | ||
|
||
To build this project you will need to install the following dependency programs on your machine: | ||
|
||
- [Bun](https://bun.sh) - https://bun.sh/ | ||
|
||
[Bun](https://bun.sh) is a Javascript runtime that is better suited to the task at hand than NodeJS seems to be, whilst remaining mostly compatible (or at least, compatible enough to run Vite). | ||
|
||
Before running, building, or doing anything with this project, you will need to install it's dependencies, this can be done with: | ||
|
||
```sh | ||
bun install | ||
``` | ||
|
||
You can start the application in development with Hot Module Reloading (HMR), and auto-restarting with: | ||
|
||
```sh | ||
bun run dev | ||
``` | ||
|
||
If you'd like to create a production-ready build, run the following commands. | ||
|
||
```sh | ||
# Create static build, project is configured to build for bun | ||
bun run build | ||
# Run the build, should be done in a docker container | ||
bun ./build/index.js | ||
``` | ||
|
||
# Project Structure | ||
|
||
```py | ||
(project root) | ||
├── src | ||
│ ├── contrib | ||
│ │ └── # code to establish a database | ||
│ ├── lib | ||
│ │ ├── components | ||
│ │ │ └── # shadcn components | ||
│ │ ├── crypto | ||
│ │ │ └── # modules for handling cryptography | ||
│ │ ├── drizzle.ts # database schemas | ||
│ │ └── server | ||
│ │ └── # server only modules | ||
│ ├── routes | ||
│ │ └── # application front-end structure | ||
│ └── test | ||
│ └── # automated tests for testing cryptography modules | ||
├── drizzle | ||
│ └── # database migration history | ||
└── static | ||
└── # static assets | ||
``` | ||
|
||
> [!NOTE] | ||
> Add build instructions |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,17 @@ | ||
export * from "../contrib/schema"; | ||
// import { | ||
// type InferSelectModel, | ||
// type InferInsertModel, | ||
// sql | ||
// } from "drizzle-orm"; | ||
|
||
// import { | ||
// blob, | ||
// sqliteTable, | ||
// text, | ||
// real, | ||
// numeric, | ||
// integer, | ||
// foreignKey, | ||
// } from "drizzle-orm/sqlite-core"; | ||
|
||
export {} |