📔 Table of Contents

• About the Project
  • Folder Structure
  • Tech Stack
• Getting Started
  • Environment Variables
  • Installation
  • Run Locally
• Contributing
• License
• Contact
• Acknowledgements

🌟 About the Project

This repository houses an incredible AI-Prompts Sharing Web Application - modern full-stack Next.js 13 application powered by MongoDB 🤖

‼️ Folder Structure

Here is the folder structure of CreativAI.

AI-Prompt-Sharing-Web/
|- app/
  |-- api/
    |-- auth/[...nextauth]
    |-- prompt/
        |-- [id]/
        |-- new/
    |-- users/[id]/posts/
  |-- create-prompt/
  |-- profile/
  |-- update-prompt/
|- components/
|- models/
|- public/assets/
|- styles/
|- utils/
|- jsconfig.json
|- next.config.js
|- package.json
|- postcss.config.js
|- tailwind.config.js

👾 Tech Stack

🧰 Getting Started

🔑 Environment Variables

In order to use this AI-Prompt Sharing Webapp you have to add some environment variables to .env file,

create .env file in root folder & add the following environment variable:

GOOGLE_CLIENT_ID=<GOOGLE_CLIENT_ID>
GOOGLE_SECRET_ID=<GOOGLE_SECRET_ID>
MONGODB_URI=<MONGODB_URI>
MONGODB_DB=<DATABASE_NAME>
NEXTAUTH_URL=<BASE_URL> 
NEXTAUTH_URL_INTERNAL=<BASE_URL>
NEXTAUTH_SECRET=<SECRET> // generate one using openssl (`openssl rand -base64 32`)

⚙️ Installation

Step 1:

Download or clone this repo by using the command below:

 https://github.com/ladunjexa/AI-Prompt-Sharing-Web.git

Step 2:

This webapp using NPM (Node Package Manager), therefore, make sure that Node.js is installed by execute the following command in console:

  node -v

Step 3:

In root folder execute the following command to get the required packages:

  npm install

🏃 Run Locally

Step 1:

Go to root folder and execute the following command in order to run the webapp:

  npm run dev

👋 Contributing

Contributions are always welcome!

See contributing.md for ways to get started.

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

⚠️ License

Distributed under the MIT License. See LICENSE.txt for more information.

🤝 Contact

Liron Abutbul - @lironabutbul6 - @ladunjexa

Project Link: https://github.com/ladunjexa/AI-Prompt-Sharing-Web

💎 Acknowledgements

This section used to mention useful resources and libraries that used in CreativAI Webapp:

• React Framework
• Next.js 13
• NextAuth.js
• TailwindCSS
• MongoDB
• Mongoose
• #JSMastery