@@ -48,6 +48,39 @@ Visit the
4848[ create-t3-app GitHub repository] ( https://github.com/t3-oss/create-t3-app ) for
4949feedback and contributions.
5050
51+ ## π Getting Started
52+
53+ ### π οΈ Environment Variables
54+
55+ To configure the environment variables, copy the example file and update the
56+ values as needed:
57+
58+ ``` bash
59+ cp .env.example .env
60+ ```
61+
62+ Open the ` .env ` file and fill in the required fields based on the projectβs
63+ needs (e.g., database credentials, API keys, etc.).
64+
65+ ### ποΈ Database Setup
66+
67+ This project uses [ SingleStore] ( https://www.singlestore.com/ ) as the primary
68+ database, with [ Drizzle ORM] ( https://orm.drizzle.team ) for type-safe, efficient
69+ data access and schema management.
70+
71+ ``` bash
72+ pnpm run db:push # Push the schema to the database
73+ pnpm run db:studio # Launch Drizzle Studio
74+ ```
75+
76+ ### πΉοΈ Development Server
77+
78+ To start the local development server:
79+
80+ ``` bash
81+ pnpm run dev
82+ ```
83+
5184## π§ Development Logbook
5285
5386Tracking progress on key features and tasks for the project.
@@ -56,3 +89,12 @@ Tracking progress on key features and tasks for the project.
5689- [ ] π Sync folder open state with the URL
5790- [ ] π Implement user authentication
5891- [ ] π Enable file upload functionality
92+
93+ ### π Note from 5-28-2025
94+
95+ Just finished up the database connection, next steps:
96+
97+ - [ ] Update schema to show files and folders
98+ - [ ] Manually insert examples
99+ - [ ] Render them in the UI
100+ - [ ] Push and make sure it all works
0 commit comments