Skip to content

Commit a4c32fd

Browse files
authored
Update README.md
1 parent a80b530 commit a4c32fd

File tree

1 file changed

+2
-38
lines changed

1 file changed

+2
-38
lines changed

README.md

Lines changed: 2 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22

33
This repo contains the starter code for the "Notely" application for the "Learn CICD" course on [Boot.dev](https://boot.dev).
44

5-
This README is for reference purposes only! Follow the instructions in the course, don't start doing all the steps here in the README.
6-
75
## Local Development
86

97
Make sure you're on Go version 1.20+.
@@ -20,40 +18,6 @@ Run the server:
2018
go build -o notely && ./notely
2119
```
2220

23-
*This starts the server in non-database mode.* It will serve a webpage at `http://localhost:8000`. However, you won't be able to interact with the webpage until you connect it to a MySQL database and run the migrations.
24-
25-
## Database Setup
26-
27-
This project uses a MySQL database for persistent storage. You can install MySQL locally for local development, or connect to a remote database.
28-
29-
Add *your* database connection string to your `.env` file. Here's an example:
30-
31-
```bash
32-
DATABASE_URL="username:password@host/dbname?tls=true"
33-
```
34-
35-
Once you have an empty database, you'll need to run migrations to create the schema. Make sure you have [goose](https://github.com/pressly/goose) installed:
36-
37-
```bash
38-
go install github.com/pressly/goose/v3/cmd/goose@latest
39-
```
40-
41-
Then run the migrations:
42-
43-
```bash
44-
./scripts/migrateup.sh
45-
```
46-
47-
Start the server:
48-
49-
```bash
50-
go build -o notely && ./notely
51-
```
52-
53-
Because the `DATABASE_URL` environment variable is set, the server will connect to the database and serve the webpage at `http://localhost:8000`. The page should be fully functional now. You can:
54-
55-
* Create a user (login as that user)
56-
* Save notes
57-
* Logout (To log in again you'll just create a new user)
21+
*This starts the server in non-database mode.* It will serve a simple webpage at `http://localhost:8000`.
5822

59-
*The purpose of this project is to just be a simple CRUD app that we can use to practice CI/CD. It's not meant to be a fully functional app.*
23+
You do not need to set up a database and any interactivity on the page yet. Instructions for that will come later in the course!

0 commit comments

Comments
 (0)