From f529ef3abcedba6dc1d1e1eb6450570776b95f71 Mon Sep 17 00:00:00 2001 From: Harriet Craven Date: Wed, 18 Sep 2024 11:49:05 +0100 Subject: [PATCH 1/3] Update installation instructions for Vite and MySQL in Readme --- README.md | 25 +++++++++++++++++++++---- 1 file changed, 21 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ddf679d5a1..b43832cf4b 100644 --- a/README.md +++ b/README.md @@ -101,8 +101,8 @@ bundle exec yard-junk --sanity The following tools are required for development: - ruby (version defined in the `.ruby-version`) -- yarn -- node (version defined in the `.nvmrc`) +- yarn (`brew install yarn`) +- node (`brew install node@` version defined in the `.nvmrc`, ensure node is in your PATH) - mysql client libraries - if you do not want to install mysql server on your machine, consider using mysql-client: `brew install mysql-client`. Alternatively, to install the MySQL required by Sequencescape (currently 8.0) @@ -220,6 +220,13 @@ bundle exec rails s Once setup, the default user/password is `admin/admin`. +### Vite + +Ensure Node is installed, and in your PATH. You might need to run +`bin/vite build --clear --mode=development` + +To start vite + #### Delayed job For background processing Sequencescape uses `delayed_job` to ensure that the server is running. It @@ -389,11 +396,21 @@ cluster formation batch which represents a flowcell. #### MySQL errors when installing -If you are using homebrew with rbenv and run into errors relating to SSL, have a look [here](https://github.com/brianmario/mysql2/issues/795#issuecomment-433219176) +- If you are using homebrew with rbenv and run into errors relating to SSL, have a look [here](https://github.com/brianmario/mysql2/issues/795#issuecomment-433219176) -If you are upgrading a homebrew MySQL locally and have an error about a missing libmysqlclient dylib file, you may need to redownload the mysql2 gem to fix it i.e. `bundle install --redownload` +- If you are upgrading a homebrew MySQL locally and have an error about a missing libmysqlclient dylib file, you may need to redownload the mysql2 gem to fix it i.e. `bundle install --redownload` This is because the mysql2 gem is simlinked to the homebrew mysql. +- If bundle install is failing to install the `mysql2` gem, try the below (updating the paths as required): + +``` +gem install mysql2 -v '0.5.6' -- \ +--with-mysql-lib=/opt/homebrew/Cellar/mysql/ \ +--with-mysql-dir=/opt/homebrew/Cellar/mysql/9.0.1_1 \ +--with-mysql-config=/opt/homebrew/Cellar/mysql/9.0.1_1/bin/mysql_config \ +--with-mysql-include=/opt/homebrew/Cellar/mysql/9.0.1_1/include +``` + #### Installing on Apple Silicon (M1) If installation issues are encountered with Docker on M1 processors, try the fixes below: From 49abbefccc1436b93400c37de4b44d2c26d9e357 Mon Sep 17 00:00:00 2001 From: Harriet Craven Date: Wed, 18 Sep 2024 12:08:00 +0100 Subject: [PATCH 2/3] update readme --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b43832cf4b..7893302632 100644 --- a/README.md +++ b/README.md @@ -225,8 +225,6 @@ Once setup, the default user/password is `admin/admin`. Ensure Node is installed, and in your PATH. You might need to run `bin/vite build --clear --mode=development` -To start vite - #### Delayed job For background processing Sequencescape uses `delayed_job` to ensure that the server is running. It @@ -321,6 +319,8 @@ yarn prettier --check . yarn prettier --write . ``` +(If prettier is not yet installed, run `yarn`. This should have ben run in `bin/setup`) + - Prettier rules are configured in .prettierrc.json - Whole files can be ignored in .prettierignore - Sections of files can be disabled using #prettier-ignore From db1217e243ce0672cae084a714eb177bedb56358 Mon Sep 17 00:00:00 2001 From: Harriet Craven Date: Wed, 18 Sep 2024 12:12:20 +0100 Subject: [PATCH 3/3] prettier --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7893302632..b8cb7e3c5c 100644 --- a/README.md +++ b/README.md @@ -399,7 +399,7 @@ cluster formation batch which represents a flowcell. - If you are using homebrew with rbenv and run into errors relating to SSL, have a look [here](https://github.com/brianmario/mysql2/issues/795#issuecomment-433219176) - If you are upgrading a homebrew MySQL locally and have an error about a missing libmysqlclient dylib file, you may need to redownload the mysql2 gem to fix it i.e. `bundle install --redownload` -This is because the mysql2 gem is simlinked to the homebrew mysql. + This is because the mysql2 gem is simlinked to the homebrew mysql. - If bundle install is failing to install the `mysql2` gem, try the below (updating the paths as required):