Skip to content

Latest commit

 

History

History
203 lines (162 loc) · 6.73 KB

README.md

File metadata and controls

203 lines (162 loc) · 6.73 KB
CRUL

+

SvelteKit

CRUL + ReactJs

Contributors Forks Stargazers Issues MIT License LinkedIn

Table of Contents
  1. Demo
  2. Built With
  3. Required Dependencies
  4. Installation
  5. Contributing
  6. Configuration
  7. Usage
  8. License
  9. Credits & References

This is an AI Image Generator that uses OpenAi's DALL-E and text-davincii-3. It generates an image out of the provided prompt. This is a game-changing software, it uses text-davincii-3 to suggest prompts for you.

Demo

https://user-images.githubusercontent.com/79797604/219990531-af5d3224-30c3-40d9-84c1-bc5b28ca022e.mp4

Built With

React NodeJs MongoDb Express.js


Status: Alpha v1.2.1,

Dependencies

The following dependencies must be installed in order for the software to work:
Frontend (Client folder): - React - React-icons - File-saver - React-dom - React-router-dom - Lodash - React-helmet
Backend (Server folder): - Express - Nodemon - Mongoose - Dotenv - Cors - Openai - Cloudinary

Installation

To use this software, open your terminal and run

cd server
npm install

once all the dependencies are done installing, run

npm run start
open a new terminal and run
cd client
 npm i
then start the frontend by running
npm run start

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Configuration

Cd into the server folder and create a .env file and fill it with your credentials from openai, mongodb and cloudinary.

    MONGODB_URL=""
    OPENAI_API_KEY=""
    CLOUDINARY_CLOUD_NAME=""
    CLOUDINARY_API_KEY=""
    CLOUDINARY_API_SECRET=""

Usage

Visit http://localhost:5173

You can go to /generate-image route to generate your AI image. You can also visit the /showcase route to view all the AI generated images


Open source licensing info

  1. CODE OF CONDUCT
  2. LICENSE
  3. CONTRIBUTING


Credits and references

  1. JavaScript Mastery's AI Image Generator Project Video
  2. Github Profile ReadMe Generator
  3. Brittnay Chiang Portfolio