Skip to content

Commit 0be5951

Browse files
authored
docs(readme): new section added (#1915)
## Description Get started section added to the README file ## Motivation Users can follow a couple of steps to run frontend locally. ## Fixes: Please provide a list of the fixes implemented in this PR * Items added ## Changes: Please provide a list of the changes implemented by this PR * changes made ## Tests included - [ ] Included for each change/fix? - [ ] Passing? (Merge will not be approved unless this is checked) ## Documentation - [ ] swagger documentation updated \[required\] - [ ] official documentation updated \[nice-to-have\] ### official documentation info If you have updated the official documentation, please provide PR # and URL of the pages where the updates are included ## Backend version - [ ] Does it require a specific version of the backend - which version of the backend is required: ## Summary by Sourcery Documentation: - Introduce a “Get started” section in README detailing Node.js/npm requirements, repository cloning, dependency installation, and startup steps
1 parent 50fe259 commit 0be5951

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,13 @@ For the full documentation please go to the [SciCat home page](https://scicatpro
2020

2121
- [Site logo related images](SITE-LOGO-CONFIGURATION.md)
2222

23+
## Get started
24+
25+
1. Ensure you have Node.js 18+ and npm installed (https://nodejs.org/en).
26+
2. `git clone https://github.com/SciCatProject/frontend.git`
27+
3. `npm install`
28+
4. `npm run start`
29+
2330
## License
2431

2532
See the [LICENSE](LICENSE) file for details.

0 commit comments

Comments
 (0)