Skip to content

meshack-mbuvi/promptopia

Repository files navigation

Promptopia

Promptopia is a Next.js application for creating and managing creative prompts, using MongoDB for data storage.

Live Demo

Check out the live app here.

Screenshot

alt text

Features

  • Create, edit, and delete creative prompts
  • Store and retrieve data from MongoDB
  • User-friendly interface

Technologies Used

  • Next.js - A React framework for server-side rendering and generating static websites
  • React - A JavaScript library for building user interfaces
  • Tailwind CSS - A utility-first CSS framework for rapid UI development
  • Mongoose and MongoDb

Getting Started

To get a local copy of the project up and running, follow these simple steps.

Prerequisites

You need to have the following software installed on your computer:

Installation

  1. Clone the repo
    git clone https://github.com/meshack_mbuvi/promptopia.git
  2. Install NPM packages
    npm install
    or if you prefer using Yarn:
    yarn install
  3. Create a .env.local file in the root of your project and add the following environment variables:
    MONGODB_URI=your_mongodb_connection_string

Running the App

To run the app in development mode, use the following command:

npm run dev

or if you are using Yarn:

yarn dev

Open http://localhost:3000 with your browser to see the result.

Usage

  • Visit the homepage to view the list of creative prompts.
  • Click on "Create Prompt" to add a new prompt.
  • Click on any prompt to view, edit, or delete it.

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.

  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 for more information.

Contact

Meshack Mbuvi - @meshack_mbuvi

Project Link: https://github.com/meshack_mbuvi/promptopia


This README provides an overview of your project, installation instructions, usage details, and contact information. You can adjust the content as needed to fit your specific project requirements.