Skip to content

feat: Update README with highlights and getting started guide #627

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 28, 2022
Merged

feat: Update README with highlights and getting started guide #627

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cee8256
feat: Update README with highlights and getting started guide
kylecarbs Mar 28, 2022
747cdf4
Merge branch 'main' into contributing
kylecarbs Mar 28, 2022
aadf806
Merge branch 'main' into contributing
kylecarbs Mar 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Merge branch 'main' into contributing
  • Loading branch information
@kylecarbs
kylecarbs committed Mar 28, 2022
commit 747cdf47b5f1143fb86d53d48b56ba54a16d8812
34 changes: 26 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Provision remote development environments with Terraform.

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

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

```bash
$ coder start --dev
Expand All @@ -23,24 +23,42 @@ $ coder start --dev
To run a production deployment with PostgreSQL:

```bash
$ CODER_PG_CONNECTION_URL="..." coder start
$ CODER_PG_CONNECTION_URL="postgres://<username>@<host>/<database>?password=<password>" \
coder start
```

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

```bash
# Edit the configuration!
$ sudo vim /etc/coder.d/coder.env
$ sudo service coder restart
```

### Your First Workspace

In a new terminal, create a new project (eg. Develop in Linux on Google Cloud):

```
$ coder projects init
$ coder projects create
```

Create a new workspace and SSH in:

```
$ coder workspaces create my-first-workspace
$ coder ssh my-first-workspace
```

## Development

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.
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).

Requires Go 1.18+, Node 14+, and GNU Make.
Coder requires Go 1.18+, Node 14+, and GNU Make.

- `make bin` build binaries
- `make install` install binaries to `$GOPATH/bin`
- `make bin` builds binaries
- `make install` installs binaries to `$GOPATH/bin`
- `make test`
- `make release` dry-run a new release
- `make release` dry-runs a new release
- `./develop.sh` hot-reloads for frontend development
You are viewing a condensed version of this merge commit. You can view the full changes here.