diff --git a/README.md b/README.md index bc661f51..7afacb92 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ SeeQR is still in BETA. Additional features, extensions, and improvements will c To get started on contributing to this project: -1. Download and Install [Docker Desktop](https://www.docker.com/get-started) +1. Download and install [Postgres App](https://postgresapp.com/) and start it before opening up SeeQR. 2. Fork or clone this repository 3. Npm install 1. Run `npm install` for application-specific dependencies. @@ -48,7 +48,6 @@ To get started on contributing to this project: 4. Install [Live Sass Compile](https://github.com/ritwickdey/vscode-live-sass-compiler) VSCode extension (settings are configured in the .vscode file in this repo), or set up your preferred Sass compiler 5. To run application during development 1. `npm run dev` to launch Electron application window and webpack-dev-server. - 2. `npm run resetContainer` to reset the container and clear pre-existing SeeQR databases. If error “can’t find postgres-1” is encountered, it is simply an indication that the container is already pruned. ## Built With @@ -56,19 +55,19 @@ To get started on contributing to this project: - [React](https://reactjs.org/) - [React-Hooks](https://reactjs.org/docs/hooks-intro.html) - [Typescript](https://www.typescriptlang.org/) -- [Docker](https://www.docker.com/get-started) -- [Docker-Compose](https://docs.docker.com/compose/) - [PostgreSQL](https://www.postgresql.org/) - [Chart.js](https://github.com/chartjs) - [Faker.js](https://github.com/Marak/faker.js) - [CodeMirror](https://codemirror.net/) ## Interface & Features +
The whole interface in a nutshell
+The whole interface in a nutshell
+ +Chris Akinrinade + |
+
+ +James Kolotouros + |
+
+ +Jennifer Courtner + |
+
+ +Katie Klochan + |
+