@effect/platform
provides a type safe API for building backend apps. Any runtime, any database, and with all the features you expect from a TypeScript backend.
Check out the full article to learn how to get started 🚀
This repository includes the following:
- Shared
effect
API definition (packages/api
) - Backend implementation with
effect
(apps/server
) - Frontend implementation with TanStack Router (
apps/client
) - Docker compose for local Postgres + PgAdmin environment (
docker-compose.yaml
)
First, open Docker Desktop and execute the below command to start the database and PgAdmin:
Make sure to create a
.env
file inside both the root directory andapps/server
, containing the parameters listed inside.env.example
.
docker compose up
This will start the database and PgAdmin. You can access http://localhost:5050/
to login into the local PgAdmin dashboard.
Use the credentials from
.env
:PGADMIN_MAIL
+PGADMIN_PW
.
You can then execute both server and client in the monorepo. Open a second terminal and run the below commands:
pnpm install
pnpm run dev
This will start client
on http://localhost:3001/
, and server
on http://localhost:3000/
.
Done ✨
Server, client, and database all now all connected. Explore more of the effect
API by playing around with the code in the repository 🕹️
Check out the full article for the details of how the code works 🚀