Skip to content

Commit

Permalink
Fix README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
yatish27 committed May 15, 2024
1 parent 1430903 commit 7b456fd
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 8 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand All @@ -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

Expand Down
11 changes: 4 additions & 7 deletions docs/installing_prerequisites.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 7b456fd

Please sign in to comment.