Skip to content

Commit 6f80b76

Browse files
baptadnbaptadn
committedDec 7, 2024
feat: update readme
1 parent 3d452d2 commit 6f80b76

File tree

1 file changed

+23
-26
lines changed

1 file changed

+23
-26
lines changed
 

‎README.md

+23-26
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,14 @@ An open-source AI avatar generator web app
1111

1212
Try it out at [photoshot.app](https://photoshot.app)
1313

14-
15-
1614
## Stack
1715

1816
- ▲ [Next.js](https://nextjs.org/) for webapp
1917
- 🖼 [Chakra UI](https://chakra-ui.com/) for UI components
2018
- 📦 [Prisma](https://www.prisma.io/) for database
2119
- 🧠 [Replicate](https://replicate.com/), a platform for running machine learning models in the cloud
2220
- 💰 [Stripe](https://stripe.com/) for payments
23-
- 👩‍🎨 [Stable Diffusion](https://replicate.com/stability-ai/stable-diffusion) an open-source text-to-image generation model
21+
- 👩‍🎨 [Flux](https://blackforestlabs.ai/) an open-source text-to-image generation model
2422

2523
## Getting Started
2624

@@ -44,29 +42,28 @@ cp .env.example .env.local
4442

4543
Update environment variable values:
4644

47-
| Environment Variable | Explanation |
48-
|--------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
49-
| DATABASE_URL | The connection string for your PostgreSQL database. It will be `postgresql://photoshot:photoshot@localhost:5432/photoshot` if you are using the provided docket setup. |
50-
| NEXTAUTH_URL | The URL of your Next.js application, used for authentication purposes with NextAuth.js. |
51-
| S3_UPLOAD_KEY | The access key for your AWS S3 bucket used for storing pictures. |
52-
| S3_UPLOAD_SECRET | The secret key for your AWS S3 bucket used for storing pictures. |
53-
| S3_UPLOAD_BUCKET | The name of your AWS S3 bucket used for storing pictures. |
54-
| S3_UPLOAD_REGION | The AWS region where your S3 bucket is located. |
55-
| REPLICATE_API_TOKEN | The [API token](https://replicate.com/account) for Replicate. |
56-
| REPLICATE_USERNAME | The username associated with your Replicate account. |
57-
| REPLICATE_MAX_TRAIN_STEPS | The maximum number of training steps for the Dreambooth AI model. Defaults to `3000`. |
58-
| REPLICATE_NEGATIVE_PROMPT | A prompt used for negative training examples in the Replicate AI model. Defualts to `cropped face, cover face, cover visage, mutated hands` |
59-
| REPLICATE_HD_VERSION_MODEL_ID | The version of the model for upscaling the generated images. Such models can be browsed [here](https://replicate.com/collections/super-resolution) |
60-
| NEXT_PUBLIC_REPLICATE_INSTANCE_TOKEN | A unique identifier for the training data. It can be any string. For best results use an identifier containing three Unicode characters, without spaces e.g. `cjw` |
61-
| SECRET | A random string used for NextAuth.js authentication. |
62-
| EMAIL_FROM | The email address from which emails will be sent. |
63-
| EMAIL_SERVER | The SMTP server URL used for sending emails. It will be `http://localhost:25` if you are using the provided docker setup, |
64-
| STRIPE_SECRET_KEY | The API key for your Stripe account. |
65-
| NEXT_PUBLIC_STRIPE_STUDIO_PRICE | The price of a studio in cents (e.g., 1000 = $10). |
66-
| NEXT_PUBLIC_STUDIO_SHOT_AMOUNT | The maximum number of shots allowed per studio. |
67-
| OPENAI_API_KEY | The API key for the OpenAI API, used for the prompt wizard feature. |
68-
| OPENAI_API_SEED_PROMPT | A seed prompt used for generating style prompts using the OpenAI API. |
69-
45+
| Environment Variable | Explanation |
46+
| ------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
47+
| DATABASE_URL | The connection string for your PostgreSQL database. It will be `postgresql://photoshot:photoshot@localhost:5432/photoshot` if you are using the provided docket setup. |
48+
| NEXTAUTH_URL | The URL of your Next.js application, used for authentication purposes with NextAuth.js. |
49+
| S3_UPLOAD_KEY | The access key for your AWS S3 bucket used for storing pictures. |
50+
| S3_UPLOAD_SECRET | The secret key for your AWS S3 bucket used for storing pictures. |
51+
| S3_UPLOAD_BUCKET | The name of your AWS S3 bucket used for storing pictures. |
52+
| S3_UPLOAD_REGION | The AWS region where your S3 bucket is located. |
53+
| REPLICATE_API_TOKEN | The [API token](https://replicate.com/account) for Replicate. |
54+
| REPLICATE_USERNAME | The username associated with your Replicate account. |
55+
| REPLICATE_MAX_TRAIN_STEPS | The maximum number of training steps for the Dreambooth AI model. Defaults to `3000`. |
56+
| REPLICATE_NEGATIVE_PROMPT | A prompt used for negative training examples in the Replicate AI model. Defualts to `cropped face, cover face, cover visage, mutated hands` |
57+
| REPLICATE_HD_VERSION_MODEL_ID | The version of the model for upscaling the generated images. Such models can be browsed [here](https://replicate.com/collections/super-resolution) |
58+
| NEXT_PUBLIC_REPLICATE_INSTANCE_TOKEN | A unique identifier for the training data. It can be any string. For best results use an identifier containing three Unicode characters, without spaces e.g. `cjw` |
59+
| SECRET | A random string used for NextAuth.js authentication. |
60+
| EMAIL_FROM | The email address from which emails will be sent. |
61+
| EMAIL_SERVER | The SMTP server URL used for sending emails. It will be `http://localhost:25` if you are using the provided docker setup, |
62+
| STRIPE_SECRET_KEY | The API key for your Stripe account. |
63+
| NEXT_PUBLIC_STRIPE_STUDIO_PRICE | The price of a studio in cents (e.g., 1000 = $10). |
64+
| NEXT_PUBLIC_STUDIO_SHOT_AMOUNT | The maximum number of shots allowed per studio. |
65+
| OPENAI_API_KEY | The API key for the OpenAI API, used for the prompt wizard feature. |
66+
| OPENAI_API_SEED_PROMPT | A seed prompt used for generating style prompts using the OpenAI API. |
7067

7168
Please note that if you want to use the provided `docker-compose` setup you have to disable `TLS` in your `.env.local` by adding:
7269

0 commit comments

Comments
 (0)