Skip to content
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

Minor README improvements #6

Merged
merged 1 commit into from
Aug 14, 2024
Merged

Minor README improvements #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 12 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

A simple implementation of an in-memory wiki server, storing Markdown documents by name.

Articles do not persist through restarts.

The project includes a UI, and is dockerized.

## Technology Stack
Expand All @@ -23,31 +25,35 @@ python3 -m venv env
source env/bin/activate
pip install -r requirements.txt

cd wiki_frontend/
cd frontend/
npm install
```

## Running and Testing

Convenience scripts are provided for running and testing the server.

### Running
### Running Locally

`run-server.sh` starts the server (only), which runs dev mode by default. It starts on port 9090.

`run-frontend` starts the frontend (only), which also runs in dev mode.

`run-tests.sh` invokes both `pytest`, which tests the backend, and `npm test` (inside the `frontend/` directory).
`run-frontend` starts the frontend (only), which also runs in dev mode. It uses port 5173.

`run-full.sh` starts both services locally.

### Testing

`run-tests.sh` invokes both `pytest`, which tests the backend, and `npm test` (inside the `frontend/` directory), for the frontend.

### Running and Building docker

`build.sh` builds the docker container, and `run-container.sh` starts it.

When the container is running, the application is accessible at http://localhost:8080/

## Documentation

As the underlying server uses Python's FastAPI, a /docs routed is automatically populated with each available route, describing its parameters and return values.
As the backend server uses Python's FastAPI, a /docs route is automatically populated, describing the schema, its parameters and return values of each endpoint.

You can access it at http://localhost:9090/docs, or http://localhost:9090/redoc (for the alternate ReDoc format).

Expand Down
Loading