You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+27-16Lines changed: 27 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,25 @@
1
-
# Sistema
1
+
# Sistema Tacet
2
2
3
-
## Setup
3
+
## Preview
4
4
5
-
- Make sure you have been added to the [UW Blueprint Github Workspace](https://github.com/uwblueprint/).
6
-
- Install Docker Desktop ([MacOS](https://docs.docker.com/docker-for-mac/install/) | [Windows](https://docs.docker.com/desktop/install/windows-install/) | [Linux](https://docs.docker.com/engine/install/#server)) and ensure that it is running.
7
-
- Install [Node.js](https://nodejs.org/) (v22 tested). It's recommended to use [NVM (Node Version Manager)](https://github.com/nvm-sh/nvm) to manage your Node.js versions.
- If you intend to contribute to this project ensure you have been added to the [UW Blueprint Github Organization](https://github.com/uwblueprint/).
18
+
- Install [Node.js](https://nodejs.org/en/download/) (v22 tested). It's recommended to use [NVM (Node Version Manager)](https://github.com/nvm-sh/nvm) to manage your Node.js versions.
19
+
- Install Docker Desktop ([MacOS](https://docs.docker.com/desktop/setup/install/mac-install/) | [Windows](https://docs.docker.com/desktop/install/windows-install/) | [Linux](https://docs.docker.com/desktop/setup/install/linux/)) and ensure that it is running.
20
+
-
21
+
22
+
## Clone and Install
12
23
13
24
- Clone the [Sistema Github Repository](https://github.com/uwblueprint/sistema) to your local machine and `cd` into the project folder:
- Make sure you have been added to the [Sistema HashiCorp Vault](https://github.com/uwblueprint/).
44
55
- Install [HashiCorp Vault](https://developer.hashicorp.com/hcp/tutorials/get-started-hcp-vault-secrets/hcp-vault-secrets-install-cli#install-hcp-vault-secrets-cli) in order to pull secrets
45
56
- In the folder where you cloned the Sistema repository, log into Vault
@@ -82,22 +93,22 @@ Use the arrow keys to navigate: ↓ ↑ → ←
82
93
83
94
## Docker Commands
84
95
85
-
If you’re new to Docker, you can learn more about `docker-compose` commands at
96
+
If you’re new to Docker, you can learn more about `dockercompose` commands at
86
97
this [docker compose overview](https://docs.docker.com/compose/reference/).
87
98
88
99
```bash
89
100
# Start Docker Containers
90
-
docker-compose up --build
101
+
dockercompose up --build
91
102
```
92
103
93
104
```bash
94
105
# Stop Containers
95
-
docker-compose down
106
+
dockercompose down
96
107
```
97
108
98
109
```bash
99
110
# Remove Containers, Networks, and Volumes:
100
-
docker-compose down --volumes
111
+
dockercompose down --volumes
101
112
```
102
113
103
114
```bash
@@ -157,7 +168,7 @@ This will open an interactive shell inside the container.
157
168
## Accessing Database
158
169
159
170
```bash
160
-
# Open a Postgres shell in the sistema-db-1 Docker container and connect to the sistema database
171
+
# Open a Postgres shell in the sistema-db-1 Docker container and connect to the sistema database
161
172
docker exec -it sistema-db-1 psql -U sistema -d sistema
162
173
# Retrieve all rows from the "Absence" table
163
174
SELECT * FROM public."Absence";
@@ -267,7 +278,7 @@ git push -f
267
278
```
268
279
269
280
- Commit messages and PR names are descriptive and written in **imperative tense**. The first word should be capitalized. E.g. "Create user REST endpoints", not "Created user REST endpoints"
270
-
- PRs can contain multiple commits, they do not need to be squashed together before merging as long as each commit is atomic. Our repo is configured to only allow squash commits to `main` so the entire PR will appear as 1 commit on `main`, but the individual commits are preserved when viewing the PR.
281
+
- PRs can contain multiple commits, they do not need to be squashed together before merging as long as each commit is atomic.
0 commit comments