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.

Sign up for GitHub

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

Jump to bottom

Made more clear steps on the readme #128

Merged
merged 3 commits into from
Nov 25, 2024
Merged

Made more clear steps on the readme #128

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
47cc328
Made more clear steps on the readme
Emos21 Aug 14, 2024
a74aaac
removed the secret keys and leaved it as **add_your_secret_keys_here**
Emos21 Aug 19, 2024
0261536
Merge branch 'dev' into amos
gvelez17 Nov 25, 2024
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
42 changes: 42 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,12 +179,14 @@ Create a `.env` file in project root. If running with docker an additional `.env
```bash
PORT=9000
DATABASE_URL="postgresql://postgres:postgres@postgres:5432/claim"

ACCESS_SECRET='...'
REFRESH_SECRET='...'
AWS_ACCESS_KEY_ID='...'
AWS_SECRET_ACCESS_KEY='...'
AWS_STORAGE_BUCKET_NAME='...'
AWS_S3_REGION_NAME='...'

```

In `.env.dev`, change `DATABASE_URL` like below, everything else can be exactly like `.env`.
Expand Down Expand Up @@ -299,3 +301,43 @@ restore the db file
```bash
docker exec -it <id> psql -U postgres -d claim -f /tmp/dump_file
```

Alternate instructions

Run

`docker run -d -p 5432:5432 -e POSTGRES_PASSWORD=postgres --name postgres-db postgres`

ensure you have a .env file

```
PORT=9000
DATABASE_URL="postgresql://postgres:postgres@localhost:5432/claim"
ACCESS_SECRET=**add_your_secret_keys_here**
REFRESH_SECRET=**add_your_secret_keys_here**
```

then run

`npm run dev`

OR

`npm run inspect`. to be able to connect with remote debugger

OR

run from within an IDE such as webstorm with simple configuration such as

<img width="852" alt="image" src="https://user-images.githubusercontent.com/798887/232255771-e3cf52db-ece2-48b0-b67f-cd8edec39776.png">
Copy link
Collaborator

Choose a reason for hiding this comment

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

great this kind of thing is super helpful, we used to do this also at uber



------------

you may also have to copy .env to .env.dev

and run

`npm run migrate:dev`

to set up the initial database