-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
37 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,38 @@ | ||
# Getting Started | ||
|
||
Get the project up and running on your own machine using Docker and docker-compose. | ||
Get the project up and running with | ||
- docker | ||
- docker-compose | ||
- colima | ||
- lazygit | ||
|
||
__Installation Requirements:__ | ||
<img src='./images-gettings-started/tldr.gif' /> | ||
|
||
</br> | ||
|
||
```bash | ||
# Commands | ||
git clone [email protected]:bouvet/bouvet-developer-survey.git | ||
cd bouvet-developer-survey | ||
brew install colima docker docker-compose lazydocker | ||
DB_PASSWORD=$(openssl rand --base64 16) | ||
echo "DB_PASSWORD=$DB_PASSWORD" > .env | ||
echo "DB_CONNECTION_STRING=Server=bds-db,1433;Database=bds-db;User ID=sa;Password=$DB_PASSWORD;TrustServerCertificate=True;" >> .env | ||
colima start --memory 4 --cpu 4 | ||
docker-compose up -d | ||
lazydocker | ||
``` | ||
|
||
**Installation Requirements:** | ||
|
||
- Install a container runtime like Docker runtime, Colima, Podman or similar container runtime. | ||
|
||
> If you are not familiar with container runtimes, I would recommend installing [Docker Desktop](https://docs.docker.com/get-started/get-docker/) .</br> | ||
> Docker Desktop includes everything you need (GUI, Docker runtime and docker-compose).</br> | ||
> __Rememeber__: In order to use Docker Desktop, you need to apply for a license with service desk, | ||
> Docker Desktop includes everything you need (GUI, Docker runtime and docker-compose).</br> > **Rememeber**: In order to use Docker Desktop, you need to apply for a license with service desk, | ||
> [bds.bouvet.no](bds.bouvet.no) | ||
__Setting up the project__ | ||
**Setting up the project** | ||
|
||
```bash | ||
# clone repo | ||
git clone [email protected]:bouvet/bouvet-developer-survey.git | ||
|
@@ -20,16 +41,18 @@ cd bouvet-developer-survey | |
|
||
touch .env | ||
``` | ||
|
||
Open your favorite editor and add thes two secrets. | ||
|
||
```bash | ||
DB_PASSWORD=<your-password> | ||
DB_CONNECTION_STRING=Server=bds-db,1433;Database=bds-db;User ID=sa;Password=<your-password>;TrustServerCertificate=True; | ||
``` | ||
|
||
If you have the package install, you can create a password | ||
from the command line using the command `openssl rand --base64 16` | ||
|
||
__Running the containers with Colima__ | ||
**Running the containers with Colima** | ||
|
||
Install colima with your preferred package manager. | ||
|
||
|
@@ -57,11 +80,9 @@ lazydocker | |
|
||
This will start the containers. | ||
|
||
TODO: Why does the import csv return 400? when it all goes through? | ||
|
||
A usefull tool to ins | ||
|
||
__Running the containers with Docker Desktop__ | ||
**Running the containers with Docker Desktop** | ||
|
||
On the root of the project, you will see a `docker-compose.yaml` file. | ||
This contains the services we want to run as docker containers. | ||
|
@@ -71,12 +92,14 @@ This contains the services we want to run as docker containers. | |
docker compose up -d | ||
|
||
``` | ||
__Import data__ | ||
|
||
Import survey and survey responses into the database. | ||
## Import into the database | ||
|
||
> Where do I find the files? Slack -> bds-team | ||
Import survey and survey responses into the database.</br> | ||
You will find the import files in the Slack channel called bds-team. | ||
</br> | ||
|
||
In order to import, the applications have to run.</br> | ||
Go to `http://localhost:5001/index.html`. This is the GUI for the | ||
Open API specification of the backend API. | ||
|
||
|
@@ -94,6 +117,8 @@ the database. Now we need to import user responses. | |
- Press "Execute". | ||
- Copy the id (GUID) from the response. | ||
|
||
Last, but not least, we need to import the answers. | ||
|
||
- Click on `/api/v1/Imports/Results`. | ||
- Paste the id from the previous step into field. | ||
- Press "Try it out" | ||
|
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.