2PORT=3001
3
4# Database Configuration
5DB_HOST=localhost
6DB_PORT=5432
7DB_USERNAME=postgres
8DB_PASSWORD=postgres
9DB_DATABASE=user_access_management
10
11# JWT Configuration
15- **Backend**: Node.js, Express.js, TypeORM
16- **Frontend**: React, React Router, Axios
17- **Database**: PostgreSQL
18- **Authentication**: JWT, bcrypt
19- **Other tools**: dotenv, nodemon
2NODE_ENV=development
3
4# Database
5DB_HOST=localhost
6DB_PORT=5432
6const PORT = process.env.PORT || 5000;
7
8// Connect to database and start server
9createConnection({
10 type: "postgres",
13 username: process.env.DB_USERNAME || "postgres",
14 password: process.env.DB_PASSWORD || "postgres",
15 database: process.env.DB_NAME || "user_access_management",
16 entities: [User, Software, Request],
17 synchronize: process.env.NODE_ENV !== "production", // Don't use in production
19})
20 .then(() => {
21 console.log("Connected to database");
22 app.listen(PORT, () => {
23 console.log(`Server running on port ${PORT}`);
25 })
26 .catch((error) => {
27 console.error("Error connecting to database:", error);
28 });
15- **Backend**: Node.js + Express.js
16- **Frontend**: React
17- **Database**: PostgreSQL
18- **ORM**: TypeORM
19- **Authentication**: JWT
822. Install dependencies: `npm install`
833. Copy `.env.example` to `.env` and configure your environment variables
844. Run database migrations: `npm run migration:run`
855. Start the development server: `npm run dev`
86
9- The **client-side entrypoint** is `/frontend/index.html`, which in turn imports `/frontend/index.tsx`, which in turn imports the React app from `/frontend/App.tsx`.
10
11[React Hono Example](https://www.val.town/x/stevekrouse/reactHonoExample) is a fuller featured example project, with a SQLite database table, queries, client-side CSS and a favicon, and some shared code that runs on both client and server.
13 const navLinks = [
14 { name: "Farcaster SDK", path: "/" },
15 { name: "Database", path: "/db" },
16 { name: "About", path: "/about" },
17 ];
35 <Routes>
36 <Route path="/" element={<FarcasterMiniApp />} />
37 <Route path="/db" element={<Database />} />
38 <Route path="/about" element={<About />} />
39 <Route path="/neynar" element={<Neynar />} />
50 <div className="">✷ Hono + React + Tailwind</div>
51 <div className="">✷ React Router + React Query</div>
52 <div className="">✷ Built-in database (blob storage)</div>
53 <div className="">✷ Farcaster mini app manifest + webhook + embed metadata</div>
54 <div className="">✷ Farcaster notifications (storing tokens, sending recurring notifications, ...)</div>
66}
67
68function Database() {
69 const queryFn = () => fetch("/api/counter/get").then((r) => r.json());
70 const { data, refetch } = useQuery({ queryKey: ["counter"], queryFn });
71 return (
72 <Section className="flex flex-col items-start gap-3 m-5">
73 {/* <h2 className="font-semibold">Database Example</h2> */}
74 <div className="">Counter value: {data}</div>
75 <Button variant="outline" onClick={() => fetch("/api/counter/increment").then(refetch)}>
4
5* `index.ts` - this is the **entrypoint** for this whole project
6* `database/` - this contains the code for interfacing with the app's SQLite database table
7
8## Hono
26## CRUD API Routes
27
28This app has two CRUD API routes: for reading and inserting into the messages table. They both speak JSON, which is standard. They import their functions from `/backend/database/queries.ts`. These routes are called from the React app to refresh and update data.
29
30## Errors
1# Database
2
3This app uses [Val Town SQLite](https://docs.val.town/std/sqlite/) to manage data. Every Val Town account comes with a free SQLite database, hosted on [Turso](https://turso.tech/). This folder is broken up into two files:
4
5* `migrations.ts` - code to set up the database tables the app needs
6* `queries.ts` - functions to run queries against those tables, which are imported and used in the main Hono server in `/backend/index.ts`
7
8## Migrations
9
10In `backend/database/migrations.ts`, this app creates a new SQLite table `reactHonoStarter_messages` to store messages.
11
12This "migration" runs once on every app startup because it's imported in `index.ts`. You can comment this line out for a slight (30ms) performance improvement on cold starts. It's left in so that users who fork this project will have the migration run correctly.
13
14SQLite has much more limited support for altering existing tables as compared to other databases. Often it's easier to create new tables with the schema you want, and then copy the data over. Happily LLMs are quite good at those sort of database operations, but please reach out in the [Val Town Discord](https://discord.com/invite/dHv45uN5RY) if you need help.
15
16## Queries
17
18The queries file is where running the migrations happen in this app. It'd also be reasonable for that to happen in index.ts, or as is said above, for that line to be commented out, and only run when actual changes are made to your database schema.
19
20The queries file exports functions to get and write data. It relies on shared types and data imported from the `/shared` directory.
3import { createTables, tableName } from "./migrations.ts";
4
5// This will create the database table if it doesn't exist.
6// This will run every time the app starts up. You can
7// comment out this line for a modest (30ms) perforamnce improvement
8// on cold starts. It's left in to ensure the database tables are
9// automatically set up correctly for users who fork this app.
10await createTables();