diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md new file mode 100644 index 0000000..10bb4f0 --- /dev/null +++ b/DEVELOPMENT.md @@ -0,0 +1,39 @@ +# Development + +## Setup + +Install the dependencies: + +```bash +pnpm install +``` + +## Get Started + +Start the dev server: + +```bash +pnpm start +``` + +Build the app for production: + +```bash +pnpm build +``` + +Preview the Production build product: + +```bash +pnpm preview +``` + +Clear persistent cache local files + +```bash +pnpm clean +``` + +## Testing + +Plan: Test serving using Nginx using Docker. diff --git a/README.md b/README.md index 5802e85..69c7bb9 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,7 @@ -# Farm + React +# CoWorkingSpace -This template should help you start developing using React and TypeScript in Farm. +## Features -## Setup +## Development -Install the dependencies: - -```bash -pnpm install -``` - -## Get Started - -Start the dev server: - -```bash -pnpm start -``` - -Build the app for production: - -```bash -pnpm build -``` - -Preview the Production build product: - -```bash -pnpm preview -``` - -Clear persistent cache local files - -```bash -pnpm clean -``` +Please refer to [Development](./DEVELOPMENT.md) for more information. \ No newline at end of file