Skip to content

dotarjun/promptropica

Repository files navigation

Promptropica

image

Table of Contents

Overview

Promptropica is an AI prompting tool designed for the modern world. This tool assists you in discovering, creating, and sharing creative prompts. It is a full-stack CRUD application built with Next.js 13. The technology stack includes Next.js, MongoDB, Next Auth, and Tailwind CSS.

Features

  • Discover prompts: Promptropica allows users to explore a vast collection of prompts curated by the community. Discover new ideas and inspirations to kickstart your creative projects.

  • Create prompts: Users can create their own prompts and contribute to the growing collection. Share your unique ideas and help others find inspiration.

  • User authentication: Next Auth is integrated into Promptropica, providing a secure and seamless user authentication experience. Users can create accounts, log in, and manage their profiles effortlessly.

Technology Stack

Promptropica is built using the following technologies:

  • Next.js: A React framework for server-side rendering and building static websites. It offers a rich development experience with features like automatic code splitting, hot module replacement, and more.

  • MongoDB: A NoSQL database used to store and manage prompt data. MongoDB provides scalability, flexibility, and seamless integration with Node.js applications.

  • Next Auth: A complete authentication solution for Next.js applications. It simplifies the process of adding authentication, including social logins, to your project.

  • Tailwind CSS: A utility-first CSS framework that enables rapid and responsive web development. It offers a wide range of pre-built components and utility classes for designing modern user interfaces.

Getting Started

To run Promptropica locally, follow the steps below:

  1. Clone the repository:
git clone https://github.com/dotarjun/promptropica.git
  1. Install the dependencies:
cd promptropica
npm install
  1. Set up environment variables:

Create a .env.local file in the root directory of the project and provide the necessary environment variables. Refer to the .env.example file for the required variables.

  1. Run the development server:
npm run dev
  1. Open your browser and visit http://localhost:3000 to access Promptropica.

Contributing

We welcome contributions from the open-source community. If you'd like to contribute to Promptropica, please follow these steps:

  1. Fork the repository on GitHub.

  2. Clone your forked repository to your local machine:

git clone https://github.com/your-username/promptropica.git
  1. Create a new branch for your feature or bug fix:
git checkout -b feature/your-feature
  1. Make your changes and commit them with descriptive commit messages.

  2. Push your changes to your forked repository:

git push origin feature/your-feature
  1. Open a pull request on the main repository, providing a detailed description of your changes.

License

Promptropica is licensed under the MIT License.