Skip to content

Commit b2698e5

Browse files
committed
docs: adjusting readme for no client
1 parent 366fe3b commit b2698e5

File tree

3 files changed

+7
-15
lines changed

3 files changed

+7
-15
lines changed

.env.docker

-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
API_URL="http://app:3000"
21
NEXT_PUBLIC_API_URL="http://localhost:3000"
32
REDIS_URL="redis://redis:6379"
43

.env.example

-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,2 @@
1-
API_URL="http://localhost:3000"
21
REDIS_URL="redis://localhost:6379"
32

README.md

+7-13
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ Your `.env.docker` file will look similar to `.env`, but should use the appropri
1818
an example:
1919

2020
```bash
21-
API_URL="http://app:3000"
2221
REDIS_URL="redis://redis:6379"
2322
```
2423

@@ -28,19 +27,14 @@ Next, spin up docker containers:
2827
docker compose up -d
2928
```
3029

31-
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. You can now edit the files in
32-
`./server` and it will update the docker container and restart the server.
30+
You should have a server running on `http://localhost:<port>` where the port is set in your `.env` file (default is 3000). You can test the following routes:
3331

34-
## Running production docker
35-
36-
There is a single `Dockerfile` setup to run in `dev` mode and `prod` mode. By default the `docker-compose.yml` file
37-
uses `dev` mode. This will run a server that watches the files for changes and restarts accordingly. When deploying,
38-
you will want to run in `prod` mode. To do that remove the following lines in the `docker-compose.yaml` file:
39-
40-
```yaml
41-
target: dev
42-
command: npm run dev
43-
```
32+
1. `GET /api/todos` - Gets all todos
33+
2. `GET /api/todos/:id` - Gets a todo by ID
34+
3. `GET /api/todos?[name=<name>]&[status=<status>]` - Search for todos by name and/or status
35+
4. `POST /api/todos` - Create a todo with `{ "name": "Sample todo" }`
36+
5. `PATCH /api/todos/:id` - Update todo by ID with `{ "status": "todo|in progress|complete" }`
37+
6. `DELETE /api/todos/:id` - Delete a todo by ID
4438

4539
## Running tests
4640

0 commit comments

Comments
 (0)