CRUL
Generate AI images using your descriptions
Install / Use
/learn @EmmanuelOmoiya/CRULREADME
Demo
https://user-images.githubusercontent.com/79797604/219990531-af5d3224-30c3-40d9-84c1-bc5b28ca022e.mp4 <br/> <br/>
Built With
<br/>Status: Alpha v1.2.1, <br/>
Dependencies
The following dependencies must be installed in order for the software to work: <br/> Frontend (Client folder): - React - React-icons - File-saver - React-dom - React-router-dom - Lodash - React-helmet <br/> Backend (Server folder): - Express - Nodemon - Mongoose - Dotenv - Cors - Openai - Cloudinary <br/>
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
<br/>
<!-- CONTRIBUTING -->
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!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - 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=""
<br/>
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
<br/>
Open source licensing info
<br/>
