From 7b456fdcee67392c8d1d19eb72b33a236c74c3ed Mon Sep 17 00:00:00 2001 From: Yatish Mehta Date: Tue, 14 May 2024 21:54:37 -0700 Subject: [PATCH] Fix README.md --- README.md | 2 +- docs/installing_prerequisites.md | 11 ++++------- 2 files changed, 5 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index ed0968e..90c32e2 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,6 @@ - **PostgreSQL**: [PostgresSQL 16.3](https://www.postgresql.org) - **Tailwind CSS**: Uses [Tailwind CSS](https://tailwindcss.com) for styling. - **Vite Ruby**: Uses [Vite Ruby](https://vite-ruby.netlify.app) for asset management. It is based on [Vite.js](https://vitejs.dev). It replaces webpacker, jsbundling-rails, cssbundling-rails, importmaps and sprockets. -- **Bun**: Uses [Bun](https://bun.sh) for npm package manager. No need to install node and yarn. - **Phlex**: Uses [Phlex](https://www.phlex.fun) for component-based views. It is an alternative to [ViewComponent](https://viewcomponent.org). - **Solid Queue**: Uses [Solid Queue](https://github.com/rails/solid_queue) for background processing. - **Minitest/FactoryBot**: Uses Rails' default testing library, minitest along with [Factorybot](https://github.com/thoughtbot/factory_bot). @@ -45,6 +44,7 @@ You will need the following installed to run the application. - Ruby [3.3.1](.ruby-version) - PostgreSQL 16.3 - Bun 1.1.8 +- Node & Yarn - [Overmind](https://github.com/DarthSim/overmind) (optional), it will be used in place of Foreman. - Docker & Docker Desktop if you want to use docker compose for local development diff --git a/docs/installing_prerequisites.md b/docs/installing_prerequisites.md index c388132..9995828 100644 --- a/docs/installing_prerequisites.md +++ b/docs/installing_prerequisites.md @@ -66,17 +66,14 @@ ALTER ROLE postgres WITH PASSWORD 'password'; 3. Start the server and initialize the cluster using the UI -## Bun -Visit [bun.sh](https://bun.sh/docs/installation) to learn about installation process - +## Node ``` -brew install oven-sh/bun/bun +brew install node ``` -After installing, check the version - +## Yarn ``` -bun -v +brew install yarn ``` ## Overmind