README.md

Full-stack boilerplate

You can use this as a starting point for your own project, or use it as a reference for your own tech stack!

Tech Stack

• Frontend:
  • Typescript
  • React
  • UI via tailwind and shadcn
• Backend:
  • Typescript
  • Fastify server
  • Sqlite via better-sqlite3

System Requirements

In order to use the boilerplate you will need the following:

• Node.js 20+

Setup steps

1. Pull the repo

git clone git@github.com:stepful/fullstack_boilerplate.git && cd fullstack_boilerplate

2. (Optional) Copy .env.sample to .env (should be sensible defaults, but feel free to make changes as desired)

cd backend # or frontend
cp .env.sample .env

3. Install packages for all workspaces, and seed DB

npm run setup

5. Start dev servers (vite, fastify)

npm run dev

You should now be able to reach the frontend app at http://localhost:3000 (and this port is configurable via VITE_FRONTEND_SERVER_PORT in .env.local). The backend is available at http://localhost:3001 (and this port is configurable via VITE_BACKEND_SERVER_PORT in .env.local).