Unreed

This is the main repository for the Unreed app.

Development

Prerequisites/tools you have to install:

• git
• Bun
• A code editor (for example: Visual Studio Code)
• MySQL

Tools that come automatically with this project

• The application is written in React.
• We use TypeScript for type checking.
• We use Storybook to develop all the UI components in isolation.
• We use Prettier to ensure that all the code follows the same style conventions.
• We use the Vite build tool, for a quick developer experience.

Setup/preparation

git clone [email protected]:eirslett/unreed-app.git
cd unreed-app
bun install

Available commands:

bun run dev

This will start Unreed locally. Will be available on http://localhost:3000.

bun run storybook

The Storybook instance should now run on http://localhost:6006.

The built version of Storybook is also hosted on https://eirslett.github.io/unreed-app/.

bun run lint:typescript

Any type errors should show up in the console. Also, it's a good idea to configure your code editor with a TypeScript plugin, which will highlight type errors directly in the editor.

bun run lint:prettier

Any formatting errrors should show up in the console. Also, it's a good idea to configure your code editor with a Prettier plugin, and set it up to automatically format the code on every save.

bun run build

This will take the index.html file, all the TypeScript and CSS files, compress and bundle them so they are ready to deploy to production.