Skip to content

hemanthsaik/Promptopia

Repository files navigation

Promptopia

Promptopia is an open-source AI prompting tool designed for the modern world, allowing users to discover, create, and share creative prompts. It is built using Next.js for both the frontend and backend, and utilizes MongoDB as the database. The authentication system is implemented using NextAuth.js. This project was developed with the teaching and guidance provided by JavaScript Mastery.

Installation

To install and run Promptopia locally, please follow the steps below:

  1. Clone the repository:
git clone https://github.com/your-username/Promptopia.git
  1. Navigate to the project directory:
cd Promptopia
  1. Install the dependencies:
npm install
  1. Start the development server:
npm run dev

Features

  • Discover creative prompts
  • Create and share prompts
  • User authentication with NextAuth.js
  • MongoDB integration for database management

Dependencies

Promptopia relies on the following dependencies:

  • Next.js: The framework used for building the frontend and backend of the application.
  • MongoDB: A NoSQL database used for data storage and management.
  • NextAuth.js: An authentication library for Next.js applications.

Usage

To use Promptopia, follow these steps:

  1. Access the Promptopia website by visiting http://localhost:3000 in your browser.

  2. Browse the available prompts to discover new ideas or create your own.

  3. Sign in or create an account using the provided authentication system.

  4. Once signed in, you can create and share prompts.

NPM Commands

The following npm commands are available for Promptopia:

  • npm run dev: Starts the development server.
  • npm run build: Builds the production-ready application.
  • npm run start: Starts the production server.

Acknowledgments

Promptopia was built with the assistance of JavaScript Mastery. Their teachings and guidance were instrumental in the development of this project. Special thanks to JavaScript Mastery for their support.

License

This project is licensed under the MIT License.