Skip to content

aakarkun/emprompt

Repository files navigation

Emprompt - AI Prompt Management System

Emprompt is a web application built with Next.js that allows users to manage AI prompts. It provides Google login integration using Next-Auth, allowing users to create, edit, delete, and copy their AI prompts. Additionally, users can visit their profile page to edit their stored prompts and review prompts from other users.

Installation

To run this project locally, you need to have Node.js and npm (Node Package Manager) installed on your machine. Follow these steps to set up the project:

  1. Clone the repository from GitHub:
git clone https://github.com/aakarkun/emprompt.git
cd emprompt
  1. Install the dependencies using npm:
npm install

Usage

Once you have installed the project dependencies, you can use the following npm scripts to run the application:

Development Mode

In development mode, you can use the following command to start the Next.js development server:

npm run dev

The development server will be available at http://localhost:3000.

Production Build

To create a production build of the application, use the following command:

npm run build

This will generate optimized production-ready files in the .next directory.

Starting the Production Server

After building the application, you can start the production server using the following command:

npm start

The application will be available at http://localhost:3000.

Linting

To lint your code and check for any code style issues, use the following command:

npm run lint

Dependencies

The project relies on the following dependencies:

  • autoprefixer: 10.4.14
  • bcrypt: ^5.1.0
  • mongodb: ^5.7.0
  • mongoose: ^7.4.1
  • next: 13.4.12
  • next-auth: ^4.22.3
  • postcss: 8.4.27
  • react: 18.2.0
  • react-dom: 18.2.0
  • tailwindcss: 3.3.3

Note: Make sure to have compatible versions of Node.js and npm to ensure the smooth functioning of the application.

Contributing

If you want to contribute to Emprompt, please follow these steps:

  1. Fork the repository on GitHub.
  2. Create a new branch with a descriptive name for your feature or bug fix.
  3. Make your changes in the new branch.
  4. Test your changes thoroughly.
  5. Commit your changes and push the branch to your forked repository.
  6. Open a pull request on the main repository.

We appreciate your contributions!

License

This project is licensed under the MIT License.


Thank you for checking out Emprompt! If you encounter any issues or have suggestions, feel free to open an issue on the GitHub repository. Happy coding! 🚀

Releases

No releases published

Packages

No packages published