Skip to content

AlexLind/Article-Imager

Repository files navigation

Article Imager

image

Article Imager is an open-source app build on the t3-stack that generates relevant images when given an article URL using the DALL-E 2 engine. This app is built to simplify the process of finding copyright free images for articles, thus saving time, effort and money for content journalists and content creators.

The app is currently deployed on vercel and can be found at https://article-imager.vercel.app/

Features

  • Generates relevant copyright free images for articles using the DALL-E 2 stable diffusion image generator
  • User-friendly interface with Discord authentication
  • Easy to integrate into any website or blog

Usage

For usage instructions, please refer to the project's documentation on GitHub.

Installation

To install the dependencies for Article Imager, you will need to have Node.js and npm installed on your machine.

  1. Clone the repository to your local machine using git clone git@github.com:AlexLind/Article-Imager.git
  2. Navigate to the project directory using cd Article-Imager
  3. Run npm install in your command line to install all the necessary dependencies.
  4. Run npm run dev to start up the application in development mode.

Environment Variables

Article Imager uses a database to store user information and the OpenAI API to generate relevant images. In order to use the app, you will need to set the following environment variables:

DATABASE_URL: The URL for the database that Article Imager will use to store user information. PostgreSQL is recommended, but will work with any database if you update the prisma schema.

NEXTAUTH_SECRET: A secret used for Next Auth, which is used for user authentication. You can generate the secret via 'openssl rand -base64 32' on Linux.

NEXTAUTH_URL: The URL for Next Auth, which is used for user authentication. Use http://localhost:[Port] in development mode, and the deployed url when deployed.

DISCORD_CLIENT_ID: The application client ID for the Discord Provider, which is used for user authentication. In order to get the ID, you need to create a new Discord application.

DISCORD_CLIENT_SECRET: The client secret for the Discord Provider, which is used for user authentication.

OPENAI_API_KEY: The API key you generate for the OpenAI API, which is used to generate image prompts and relevant article images.

You can set these environment variables in a .env file in the root of the project directory, or set them in your operating system's environment variable settings.

Once you have set the environment variables, you can start the app by running npm start in the project directory.

Contributing

We welcome contributions to Article Imager. If you're interested in contributing, please take a look at our CONTRIBUTING.md file for more information.

Licence

Article Imager is licensed under the MIT License.

Contact

If you have any questions or suggestions, feel free to contact us at email or open an issue on GitHub.

About

Final Project @boolean UK - Full Stack Software Development Course

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published