Skip to content

✏ Update header titles for consistency #708

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

Merged
tiangolo merged 1 commit into from
Mar 13, 2024
Merged

✏ Update header titles for consistency #708

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
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,15 +43,15 @@

[![API docs](img/dashboard-user-settings.png)](https://github.com/tiangolo/full-stack-fastapi-template)

### Interactive API documentation
### Interactive API Documentation

[![API docs](img/docs.png)](https://github.com/tiangolo/full-stack-fastapi-template)

### Dashboard - Dark Mode

[![API docs](img/dashboard-dark.png)](https://github.com/tiangolo/full-stack-fastapi-template)

## How to use it
## How To Use It

You can **just fork or clone** this repository and use it as is.

Expand All @@ -67,7 +67,7 @@ Before deploying it, make sure you change at least the values for:
- `FIRST_SUPERUSER_PASSWORD`
- `POSTGRES_PASSWORD`

### Generate secret keys
### Generate Secret Keys

Some environment variables in the `.env` file have a default value of `changethis`.

Expand All @@ -79,7 +79,7 @@ python -c "import secrets; print(secrets.token_urlsafe(32))"

Copy the content and use that as password / secret key. And run that again to generate another secure key.

## How to use it - alternative with Copier
## How To Use It - Alternative With Copier

This repository also supports generating a new project using [Copier](https://copier.readthedocs.io).

Expand All @@ -101,7 +101,7 @@ pipx install copier

**Note**: If you have `pipx`, installing copier is optional, you could run it directly.

### Generate a Project with Copier
### Generate a Project With Copier

Decide a name for your new project's directory, you will use it below. For example, `my-awesome-project`.

Expand All @@ -119,7 +119,7 @@ pipx run copier copy https://github.com/tiangolo/full-stack-fastapi-template my-

**Note** the `--trust` option is necessary to be able to execute a [post-creation script](https://github.com/tiangolo/full-stack-fastapi-template/blob/master/.copier/update_dotenv.py) that updates your `.env` files.

### Input variables
### Input Variables

Copier will ask you for some data, you might want to have at hand before generating the project.

Expand Down