Skip to content

docs(readme): new section added #1915

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Conversation

abdimo101
Copy link

@abdimo101 abdimo101 commented Jun 26, 2025

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

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @abdimo101 - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@abdimo101 abdimo101 requested a review from Junjiequan June 26, 2025 09:43
@abdimo101 abdimo101 changed the title Update README.md feat: New section in the README.md Jun 26, 2025
@abdimo101 abdimo101 changed the title feat: New section in the README.md feat(README.md): New section added Jun 26, 2025
Copy link
Member

@Junjiequan Junjiequan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

docs(readme): xxx
might fit more to the changes

README.md Outdated
@@ -20,6 +20,13 @@ For the full documentation please go to the [SciCat home page](https://scicatpro

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

## Get started

1. Ensure you have up-to-date LTS versions of Node.js and npm installed (https://nodejs.org/en).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Angular 19 supports node 18+

@abdimo101 abdimo101 changed the title feat(README.md): New section added docs(readme): New section added Jun 27, 2025
@Junjiequan Junjiequan changed the title docs(readme): New section added docs(readme): new section added Jun 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants