Skip to content

Commit 747cdf4

Browse files
kylecarbskylecarbs
committed
Merge branch 'main' into contributing
2 parents cee8256 + eb18925 commit 747cdf4

File tree

4 files changed

+29
-8
lines changed

4 files changed

+29
-8
lines changed

‎.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ node_modules
1313
vendor
1414
.eslintcache
1515
yarn-error.log
16+
.idea
1617

1718
# Front-end ignore
1819
.next/

‎README.md

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Provision remote development environments with Terraform.
1414

1515
Install [the latest release](https://github.com/coder/coder/releases).
1616

17-
To tinker, start with dev-mode (all data is in-memory):
17+
To tinker, start with dev-mode (all data is in-memory, and is destroyed on exit):
1818

1919
```bash
2020
$ coder start --dev
@@ -23,24 +23,42 @@ $ coder start --dev
2323
To run a production deployment with PostgreSQL:
2424

2525
```bash
26-
$ CODER_PG_CONNECTION_URL="..." coder start
26+
$ CODER_PG_CONNECTION_URL="postgres://<username>@<host>/<database>?password=<password>" \
27+
coder start
2728
```
2829

29-
To run as a daemon, use the provided service (Linux only):
30+
To run as a system service, install with `.deb` or `.rpm`:
3031

3132
```bash
33+
# Edit the configuration!
3234
$ sudo vim /etc/coder.d/coder.env
3335
$ sudo service coder restart
3436
```
3537

38+
### Your First Workspace
39+
40+
In a new terminal, create a new project (eg. Develop in Linux on Google Cloud):
41+
42+
```
43+
$ coder projects init
44+
$ coder projects create
45+
```
46+
47+
Create a new workspace and SSH in:
48+
49+
```
50+
$ coder workspaces create my-first-workspace
51+
$ coder ssh my-first-workspace
52+
```
53+
3654
## Development
3755

38-
Code structure is inspired by [Basics of Unix Philosophy](https://homepage.cs.uri.edu/~thenry/resources/unix_art/ch01s06.html) and [Effective Go](https://go.dev/doc/effective_go); these should be read prior to contributing.
56+
The code structure is inspired by [Basics of Unix Philosophy](https://homepage.cs.uri.edu/~thenry/resources/unix_art/ch01s06.html) and [Effective Go](https://go.dev/doc/effective_go).
3957

40-
Requires Go 1.18+, Node 14+, and GNU Make.
58+
Coder requires Go 1.18+, Node 14+, and GNU Make.
4159

42-
- `make bin` build binaries
43-
- `make install` install binaries to `$GOPATH/bin`
60+
- `make bin` builds binaries
61+
- `make install` installs binaries to `$GOPATH/bin`
4462
- `make test`
45-
- `make release` dry-run a new release
63+
- `make release` dry-runs a new release
4664
- `./develop.sh` hot-reloads for frontend development

‎site/.eslintignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
###############################################################################
22
# COPY PASTA OF .gitignore
33
###############################################################################
4+
.idea
45
node_modules
56
vendor
67
out

‎site/.prettierignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ node_modules
99
vendor
1010
.eslintcache
1111
yarn-error.log
12+
.idea
1213

1314
# Front-end ignore
1415
.next/

0 commit comments

Comments
 (0)