Skip to content
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

Update outdated packages and add dev scripts #155

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

nickvisut
Copy link
Collaborator

Description

Adds npm install to next-dev and adds a script dev-frontend that will rebuild and stand up only the the back end Docker containers; also updates outdated packages.

This is a follow-up to #92. The updated packages fix the npm install warnings caused by the associated PR.

Type of changes

  • Bugfix
  • Chore
  • New Feature

Testing

  • I added automated tests
  • I think tests are unnecessary

How to test

N/A

* add dev scripts for convenience
Copy link

vercel bot commented Jan 16, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
datasci-earthquake ❌ Failed (Inspect) Jan 16, 2025 2:47am

@@ -4,13 +4,17 @@
"private": true,
"scripts": {
"fastapi-dev": "pip3 install -r requirements.txt && fastapi dev backend/api/main.py",
"next-dev": "next dev",
"next-dev": "npm install && next dev",
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

added in npm install to make it consistent with fastapi-dev

"dev": "concurrently \"npm run next-dev\" \"npm run fastapi-dev\"",
"build": "next build",
"start": "next start",
"lint": "next lint",
"format": "prettier --write .",
"test": "jest"
"test": "jest",
"dev-back": "npm docker-front && npm run fastapi-dev",
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

convenience scripts for specialist development

The former command generates a migration script in `backend/alembic/versions`, and the second command runs it.
The former command generates a migration script in `backend/alembic/versions`, and the second command runs it.

# Other resources
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

moved this from above

@@ -99,6 +100,43 @@ To stop and shut down the application:

---

## Hybrid development
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

this section is new; please review

@@ -131,7 +169,7 @@ We use GitHub Secrets to store sensitive environment variables. A template `.env
**Note**: Before starting work on the project, make sure to:

1. Get **write** access to the repository
2. Trigger the `Generate .env File` workflow and download the artifact.
2. Trigger the `Generate .env File` workflow [on the repository's Actions page](https://github.com/sfbrigade/datasci-earthquake/actions) download the artifact. You can trigger the workflow with the `Run workflow` button, navigate to the workflow run page, and find the artifact at the bottom.
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@amnak613 I added add'l detail here about the .env file

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.

1 participant