Skip to content

Commit 081d35d

Browse files
committed
dx: simplify getting started
1 parent 375df50 commit 081d35d

File tree

2 files changed

+11
-28
lines changed

2 files changed

+11
-28
lines changed

.env.example

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ LOGIN_CODE_SALT="algora-login-code"
66
LOCAL_STORE_TTL=3600
77
LOCAL_STORE_SALT="algora-local-store"
88

9-
DATABASE_URL="postgresql://user:pass@localhost:5432/db"
9+
DATABASE_URL="postgresql://algora:password@localhost:5432/algora"
1010

1111
GITHUB_CLIENT_ID=""
1212
GITHUB_CLIENT_SECRET=""

README.md

Lines changed: 10 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -130,19 +130,7 @@ To get a local copy up and running, follow these steps.
130130
asdf install
131131
```
132132

133-
3. Fetch dependencies
134-
135-
```sh
136-
mix deps.get
137-
```
138-
139-
4. Initialize your `.env` file
140-
141-
```sh
142-
cp .env.example .env
143-
```
144-
145-
5. Create your database
133+
3. Create a new PostgreSQL user
146134

147135
```sh
148136
sudo -u postgres psql
@@ -153,35 +141,30 @@ To get a local copy up and running, follow these steps.
153141
ALTER USER algora WITH CREATEDB;
154142
```
155143

156-
6. Paste your connection string into your `.env` file
157-
158-
```env
159-
DATABASE_URL="postgresql://algora:password@localhost:5432/console"
160-
```
161-
162-
7. Allow direnv to load the `.env` file
144+
4. Initialize and load `.env`
163145

164146
```sh
147+
cp .env.example .env
165148
direnv allow .env
166149
```
167150

168-
8. Run migrations and seed your database
151+
5. Install and setup dependencies
169152

170153
```sh
171-
mix ecto.setup
154+
mix setup
172155
```
173156

174-
9. Start your development server
157+
6. Start your development server
175158

176159
```sh
177160
iex -S mix phx.server
178161
```
179162

180-
10. (Optional) Watch for file changes and auto reload IEx shell in a separate terminal
163+
7. (Optional) Watch for file changes and auto reload IEx shell in a separate terminal
181164

182-
```sh
183-
find lib/ | entr mix compile
184-
```
165+
```sh
166+
find lib/ | entr mix compile
167+
```
185168

186169
### Setting up external services
187170

0 commit comments

Comments
 (0)