Skip to content

Commit

Permalink
Better readme
Browse files Browse the repository at this point in the history
  • Loading branch information
nmagee committed Mar 14, 2024
1 parent 4a27100 commit fa9ba64
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
# FastAPI Demo

## Setup
## Getting Started

### Gitpod

The easiest way to start working is to append `https://gitpod.io/#` before the URL of your repository. This should look something like but using the URL of your fork:

> [**https://gitpod.io/#https://github.com/nmagee/fastapi-demo**](https://gitpod.io/#https://github.com/nmagee/fastapi-demo)
From within Gitpod, you have a full IDE to work with the code. You can run commands in the terminal, preview the application, and git add/commit/push.

### Local

After forking this repository for your own work, you may need to set up an isolated environment in Python. I would suggest using `pipenv` for this:

Expand All @@ -12,8 +22,8 @@ python3 -m pip install pipenv
# create a new virtual environment
pipenv shell
# You can exit from that virtual environment at any point
# You can return to it again by running "pipenv shell" from that directory.
# Exit the virtual environment at any point with "exit"
# Return to it by running "pipenv shell" from the directory.
```

## Development
Expand Down

0 comments on commit fa9ba64

Please sign in to comment.