Skip to content

Commit

Permalink
big refac
Browse files Browse the repository at this point in the history
  • Loading branch information
brunolnetto committed May 14, 2024
1 parent 54fcdcd commit 63b1782
Show file tree
Hide file tree
Showing 69 changed files with 2,630 additions and 2,692 deletions.
8 changes: 4 additions & 4 deletions .env
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,10 @@ SENTRY_DSN=

# Database information
POSTGRES_HOST="localhost"
POSTGRES_USER="postgres"
POSTGRES_DB="mydb"
POSTGRES_PASSWORD="changeit"
POSTGRES_PORT=5432
POSTGRES_USER="conexxoapi"
POSTGRES_DB="Dados_RFB"
POSTGRES_PASSWORD="erw234$"
POSTGRES_PORT=5433

# JWT information
SECRET_KEY="changeit"
Expand Down
3 changes: 3 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,9 @@ install: ## Installs the python requirements. Usage: make install
build: sanitize ## Builds the application. Usage: make build
docker-compose build --no-cache

db-test: ## Host database for test
docker compose -f docker-compose.db.yml up -d

run: ## Run the application. Usage: make run
uvicorn backend.app.main:app --reload --workers 1 --host 0.0.0.0 --port 8000

Expand Down
74 changes: 3 additions & 71 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,81 +35,13 @@ 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

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

It will copy all the files, ask you configuration questions, and update the `.env` files with your answers.

<details>
### Install Copier

You can install Copier with:

```bash
pip install copier
```

Or better, if you have [`pipx`](https://pipx.pypa.io/), you can run it with:

```bash
pipx install copier
```

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

### Generate a Project With Copier

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

Go to the directory that will be the parent of your project, and run the command with your project's name:

```bash
copier copy https://github.com/tiangolo/full-stack-fastapi-template my-awesome-project --trust
```

If you have `pipx` and you didn't install `copier`, you can run it directly:

```bash
pipx run copier copy https://github.com/tiangolo/full-stack-fastapi-template my-awesome-project --trust
```

**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

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

But don't worry, you can just update any of that in the `.env` files afterwards.

The input variables, with their default values (some auto generated) are:

- `project_name`: (default: `"FastAPI Project"`) The name of the project, shown to API users (in .env).
- `stack_name`: (default: `"fastapi-project"`) The name of the stack used for Docker Compose labels and project name (no spaces, no periods) (in .env).
- `secret_key`: (default: `"changethis"`) The secret key for the project, used for security, stored in .env, you can generate one with the method above.
- `first_superuser`: (default: `"[email protected]"`) The email of the first superuser (in .env).
- `first_superuser_password`: (default: `"changethis"`) The password of the first superuser (in .env).
- `smtp_host`: (default: "") The SMTP server host to send emails, you can set it later in .env.
- `smtp_user`: (default: "") The SMTP server user to send emails, you can set it later in .env.
- `smtp_password`: (default: "") The SMTP server password to send emails, you can set it later in .env.
- `emails_from_email`: (default: `"[email protected]"`) The email account to send emails from, you can set it later in .env.
- `postgres_password`: (default: `"changethis"`) The password for the PostgreSQL database, stored in .env, you can generate one with the method above.
- `sentry_dsn`: (default: "") The DSN for Sentry, if you are using it, you can set it later in .env.
</details>

## Documentation

### Backend Development

Backend docs: [backend/README.md](./backend/README.md).

### Deployment

Deployment docs: [deployment.md](./deployment.md).
- Backend docs: [backend/README.md](./backend/README.md).

### Development
- Deployment docs: [deployment.md](./deployment.md).

General development docs: [development.md](./development.md).
- General development docs: [development.md](./development.md).

This includes using Docker Compose, custom local domains, `.env` configurations, etc.

Expand Down
4 changes: 0 additions & 4 deletions backend/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,6 @@ COPY ./scripts/ /app/

COPY ./alembic.ini /app/

COPY ./prestart.sh /app/

COPY ./tests-start.sh /app/

COPY ./app /app/app

# Run the application
Expand Down
113 changes: 0 additions & 113 deletions backend/alembic.ini

This file was deleted.

1 change: 0 additions & 1 deletion backend/app/alembic/README

This file was deleted.

90 changes: 0 additions & 90 deletions backend/app/alembic/env.py

This file was deleted.

26 changes: 0 additions & 26 deletions backend/app/alembic/script.py.mako

This file was deleted.

1 change: 1 addition & 0 deletions backend/app/api/dependencies/auth.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,4 @@

# Dependency to get password form
PasswordFormDependency = Annotated[OAuth2PasswordRequestForm, Depends()]

Loading

0 comments on commit 63b1782

Please sign in to comment.