Skip to content

Commit 734235f

Browse files
committed
update readme - minor changes
1 parent a02f2db commit 734235f

File tree

1 file changed

+31
-21
lines changed

1 file changed

+31
-21
lines changed

frontend/README.md

Lines changed: 31 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
1-
# EMBER Archive Frontend
1+
# EMBER Archive
22

3-
A Vue.js 3 / Quasar Project
3+
## EMBER: Ecosystem for Multi-modal Brain-behavior Experimentation and Research
4+
5+
EMBER is the NIH BRAIN Initiative data archive for multi-modal neurophysiological and behavioral data, supporting the Brain Behavior Quantification and Synchronization (BBQS) Program.
6+
7+
This repository contains a Vue.js 3 + Quasar frontend supporting the EMBER Archive.
48

59
## Prerequisities
610

@@ -11,28 +15,34 @@ A Vue.js 3 / Quasar Project
1115

1216
1. (Recommend) Ensure you have `nvm` installed and enabled
1317

14-
```bash
15-
nvm on
16-
nvm use
17-
```
18+
```bash
19+
nvm on
20+
nvm use
21+
```
22+
23+
## _Note: For Windows users, if you needed to modify any environment variables, make sure you close and restart any terminals before trying to run nvm or npm commands_
24+
25+
- nvm use will activate the Node.js version specified in frontend/.nvmrc
1826

19-
## _Note: For Windows users, if you needed to modify any environment variables, make sure you close and restart any terminals before trying to run nvm or npm commands_
27+
1. Install `yarn`
2028

21-
- nvm use will activate the Node.js version specified in frontend/.nvmrc
29+
```bash
30+
npm install --global yarn
31+
```
2232

2333
1. Install dependencies
2434

25-
```bash
26-
yarn install
27-
```
35+
```bash
36+
yarn install
37+
```
2838

2939
## Development
3040

3141
1. Start the application in development mode
3242

33-
```bash
34-
yarn quasar dev
35-
```
43+
```bash
44+
yarn run dev
45+
```
3646

3747
1. The frontend should now be running at [http://localhost:9000](). The application will reload as you make edits.
3848

@@ -49,16 +59,16 @@ The workflow is triggered **on every pull request** and runs the following jobs:
4959
- **Job**: `link-check`
5060
- **Purpose**: Runs [ESLint](https://eslint.org/) to identify and enforce coding style and best practices.
5161
- **Failure Resolution**:
52-
- Run `yarn run lint` locally to see the errors.
53-
- Fix the reported linting issues.
54-
- This can either be done manually, or with `yarn run lint-fix`
55-
- Commit and push the changes.
62+
- Run `yarn run lint` locally to see the errors.
63+
- Fix the reported linting issues.
64+
- This can either be done manually, or with `yarn run lint-fix`
65+
- Commit and push the changes.
5666

5767
#### Prettier Check
5868

5969
- **Job**: `format-check`
6070
- **Purpose**: Runs [Prettier](https://prettier.io/) to check if the code follows the required formatting.
6171
- **Failure Resolution**:
62-
- Run `yarn run format-check` locally to see the errors.
63-
- Run `yarn run format` locally to automatically fix formatting issues.
64-
- Commit and push the changes.
72+
- Run `yarn run format-check` locally to see the errors.
73+
- Run `yarn run format` locally to automatically fix formatting issues.
74+
- Commit and push the changes.

0 commit comments

Comments
 (0)