README.md

Admiral Express Server Example App

This is a simple example of how to use Admiral with an Express server.

🚀 Running the example

1. Install dependencies for the Express Server.

   yarn install

2. Setup Database.

   yarn prisma:generate
   yarn prisma:migrate dev

3. Start Express Server.

   yarn dev

4. Install dependencies & start Admiral.

   Navigate into the example’s directory and install its dependencies.

   cd admiral
   yarn install
   yarn build
   cp .env.example .env
   yarn dev

5. Enjoy Admiral.

   Visit http://localhost:3000

   Credentials:

   Login: [email protected]
   Password: password
   

📝 Notes

• The example uses Express to serve API.
• The example uses Prisma to manage the database. You can find the schema in src/prisma/schema.prisma. You can also find the seed data in src/prisma/seed.ts.

🧐 What’s inside?

• admiral/ - Admiral Admin
• src/ - Express Server
• src/prisma/ - Prisma Database
• package.json - dependencies and scripts
• tsconfig.json - TypeScript configuration