Skip to content

Igsu-Bravo/mirkwood

Repository files navigation

Mirkwood

Netlify Status

Prerequisites

  • This app is built using Redwood, which requires Node.js (>=14.19.x <=16.x) and Yarn (>=1.15)

Start by installing dependencies, note that this app doesn't work with NPM

yarn install

Start the development server

yarn redwood dev

Your browser should automatically open to http://localhost:8910

Prisma and the database

Live enviroment uses Psql hosted on Railway. Locally you'll need to connect to a remote db or use a local psql instance, for example in a Docker container

Database schema definitions can be found from the schema.prisma file in api/db. DB models look something like this:

model Company {
  id        String      @id @default(uuid())
  name      String
  Developer Developer[]
  Office    Office[]
}

This project uses Prisma as an ORM to talk to the database. Prisma's schema offers a declarative way of defining your app's data models. And Prisma Migrate uses that schema to make database migrations hassle-free:

yarn rw prisma migrate dev

# ...

? Enter a name for the new migration: › create posts

Storybook

Mockup, build, and verify your React components, even in complete isolation from the backend:

yarn rw storybook

Testing

yarn rw test

Deployment

App is configured to run on Netlify. Pushes to the main branch will trigger new deployments

#Thank

Spice Program Sponsored