To work on the Remix app, please follow the steps:
- Get the code:
$ git clone git@github.com:yetanother-blog/nots.git- Install dependencies:
$ npm install- Start docker compose to run a local Postgres database:
npm run docker:up- Migrate database:
$ npx drizzle-kit migrate- Start Remix dev server:
$ npm run devGo to http://localhost:5173/.
We use Storybook to develop UI components. All UI components live in ~/app/ui. To start Storybook, just run npm run storybook and go to http://localhost:6006/.
Every merge on main triggers a deployment pipeline. The pipeline runs some checks and deploys the Remix app and Storybook. We have the following deployed instances:
| Name | URL |
|---|---|
| App (staging) | https://nots-app-staging.vercel.app/ |
| App (prod) | https://nots-app-prod.vercel.app/ |
| UI (prod) | https://nots-ui-prod.vercel.app/ |
In addition, every authorized pull request deploys a preview deployment of Storybook. You can find the link to the preview in the pull request.