Skip to content

Commit f797f67

Browse files
committed
Update README with updated dev help
1 parent 9c8d2b4 commit f797f67

1 file changed

Lines changed: 19 additions & 8 deletions

File tree

README.md

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,14 @@ Some configuration is exposed via environment variables. See [configItems.js](ht
1818

1919
See [docker-validation](https://github.com/rickbergfalk/sqlpad/tree/master/docker-validation) folder for example docker-compose setup with SQL Server.
2020

21-
## Heads up! Directory structure will be changing as things are refactored
21+
## Heads up! There will be quite a bit of refactoring over next few months.
2222

2323
## Development
2424

2525
* Clone/download repo
2626
* Install node 6 or later (nvm recommended)
2727
* Install npm5 via `npm i npm -g`
28+
* Install npm modules by running `npm install`
2829
* run `npm start`
2930

3031
At this point you should have both backend and front-end development servers running.
@@ -36,22 +37,32 @@ Both front-end/back-end should auto-refresh/auto-reload on file change.
3637

3738
To build front-end production files run `npm run build`.
3839

39-
See [wiki](https://github.com/rickbergfalk/sqlpad/wiki/Development-Guide) for additional development details and project information.
40-
4140
### Databases
4241

43-
A docker-compose file is provided to provide a variety of SQL database services to develop and test against.
44-
To run these, first install docker and then run the following commands:
42+
A docker-compose file with is provided to provide an empty postgres database to test with.
43+
If you have docker installed you can do the following:
4544

4645
```sh
47-
# Bring database containers up
48-
docker-compose up
49-
# To bring down
46+
# Bring database containers up in background
47+
docker-compose up -d
48+
49+
# To bring database down
5050
docker-compose down
51+
5152
# To remove dangling containers volumes etc
5253
docker system prune
5354
```
5455

56+
To connect to the database within SQLPad during development use the following settings:
57+
58+
```
59+
driver: postgres
60+
host: localhost
61+
database: sqlpad
62+
username: sqlpad
63+
password: sqlpad
64+
```
65+
5566
## License
5667

5768
MIT

0 commit comments

Comments
 (0)