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

chore(): Minor clean up and edits #38

Merged
merged 2 commits into from
Nov 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .env.sample
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
export POSTGRES_HOST=localhost
export POSTGRES_PORT=5432
export POSTGRES_USER=postgres
export POSTGRES_PASSWORD=secret
3 changes: 0 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,6 @@ node_modules/
!.yarn/sdks
!.yarn/versions

# Node version directives
.nvmrc

# dotenv environment variables file
.env
.env.test
Expand Down
1 change: 1 addition & 0 deletions .nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
v18
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Mozilla [Backstage](https://backstage.io) App

## Developing
## Developing

### Dependencies

Expand All @@ -13,6 +13,8 @@ docker run -e POSTGRES_PASSWORD=secret -p 5432:5432 postgres:15
Set environment variables for postgres (or use `.env` file):

```sh
cp .env.sample .env

export POSTGRES_HOST=localhost
export POSTGRES_PORT=5432
export POSTGRES_USER=postgres
Expand All @@ -22,12 +24,14 @@ export POSTGRES_PASSWORD=secret
To start the app, run:

```sh
nvm use
yarn install
yarn dev
```

If using a `.env` file for the environment variables:

```sh
npm install -g dotenv-cli (if you don't have dotenv installed already)
dotenv -- yarn dev
```
```
2 changes: 2 additions & 0 deletions packages/backend/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
},
"dependencies": {
"@backstage/backend-defaults": "^0.5.1",
"@backstage/backend-plugin-api": "^1.0.1",
"@backstage/catalog-model": "^1.7.0",
"@backstage/config": "^1.2.0",
"@backstage/plugin-app-backend": "^0.3.76",
"@backstage/plugin-auth-backend": "^0.23.1",
Expand Down
2 changes: 2 additions & 0 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -14091,6 +14091,8 @@ __metadata:
resolution: "backend@workspace:packages/backend"
dependencies:
"@backstage/backend-defaults": "npm:^0.5.1"
"@backstage/backend-plugin-api": "npm:^1.0.1"
"@backstage/catalog-model": "npm:^1.7.0"
"@backstage/cli": "npm:^0.28.0"
"@backstage/config": "npm:^1.2.0"
"@backstage/plugin-app-backend": "npm:^0.3.76"
Expand Down
Loading