Awesome
Terminus OS Notifications System
This is an official Terminus OS Notifications System.
Using this example
Run the following command:
npx create-turbo@latest -e with-prisma
What's inside?
This turborepo includes the following packages/apps:
Apps and Packages
web
: a Next.js appconfig
:eslint
configurations (includeseslint-config-next
andeslint-config-prettier
)database
: Prisma ORM wrapper to manage & access your databasetsconfig
:tsconfig.json
s used throughout the monorepo
Each package/app is 100% TypeScript.
Utilities
This turborepo has some additional tools already setup for you:
- TypeScript for static type checking
- ESLint for code linting
- Prettier for code formatting
- Prisma for database ORM
- Docker Compose for local database
Database
We use Prisma to manage & access our database. As such you will need a database for this project, either locally or hosted in the cloud.
To make this process easier, we offer a docker-compose.yml
file to deploy a MySQL server locally with a new database named turborepo
(To change this update the MYSQL_DATABASE
environment variable in the docker-compose.yml
file):
cd my-turborepo
docker-compose up -d
Once deployed you will need to copy the .env.example
file to .env
in order for Prisma to have a DATABASE_URL
environment variable to access.
cp .env.example .env
If you added a custom database name, or use a cloud based database, you will need to update the DATABASE_URL
in your .env
accordingly.
Once deployed & up & running, you will need to create & deploy migrations to your database to add the necessary tables. This can be done using Prisma Migrate:
npx prisma migrate dev
If you need to push any existing migrations to the database, you can use either the Prisma db push or the Prisma migrate deploy command(s):
yarn run db:push
# OR
yarn run db:migrate:deploy
There is slight difference between the two commands & Prisma offers a breakdown on which command is best to use.
An optional additional step is to seed some initial or fake data to your database using Prisma's seeding functionality.
To do this update check the seed script located in packages/database/src/seed.ts
& add or update any users you wish to seed to the database.
Once edited run the following command to run tell Prisma to run the seed script defined in the Prisma configuration:
yarn run db:seed
For further more information on migrations, seeding & more, we recommend reading through the Prisma Documentation.
Build
To build all apps and packages, run the following command:
yarn run build
Develop
To develop all apps and packages, run the following command:
yarn run dev
Useful Links
Learn more about the power of Turborepo: