Getting Started

The Louvelle Admin Application (referred to throughout this documentation as ‘Admin’) is a React application written in Typescript, built on top of the Remix framework, connected to a postgres database through the Drizzle ORM.

The Mobile Client Application (referred to as the ‘App’) is a React-Native Expo application connected to the backend through a standard API.

Local Development (Admin)

Before you can successfully create the local project, you’ll need copies of the seed.config.ts and .env files.

You’ll also need Docker Desktop and PNPM. After installation, follow these steps:

1. clone the github repo
2. cd into the project directory
3. install dependencies with pnpm install
4. move the .env and seed.config.ts files into the project root
5. start the docker services with docker-compose up -d
6. initialize the database with NODE_ENV=local npx drizzle-kit migrate --config=drizzle/config/local.ts
7. seed the database with pnpm db:seed:local.

If these steps all succeed, you should see 🌱 Database has been seeded in your console.

Now run the admin stack with pnpm local. By default the application runs on port 5173

Your login credentials can be found in the seed.config.ts file.

Inspecting The Database

It can be helpful to use a database IDE like DataGrip or dBeaver to view the database tables.

The username and password are both postgres by default.