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.
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:
- Clone the repository from GitHub:
git clone https://github.com/aakarkun/emprompt.git
cd emprompt
- Install the dependencies using npm:
npm install
Once you have installed the project dependencies, you can use the following npm scripts to run the application:
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
.
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.
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
.
To lint your code and check for any code style issues, use the following command:
npm run lint
The project relies on the following dependencies:
autoprefixer
: 10.4.14bcrypt
: ^5.1.0mongodb
: ^5.7.0mongoose
: ^7.4.1next
: 13.4.12next-auth
: ^4.22.3postcss
: 8.4.27react
: 18.2.0react-dom
: 18.2.0tailwindcss
: 3.3.3
Note: Make sure to have compatible versions of Node.js and npm to ensure the smooth functioning of the application.
If you want to contribute to Emprompt, please follow these steps:
- Fork the repository on GitHub.
- Create a new branch with a descriptive name for your feature or bug fix.
- Make your changes in the new branch.
- Test your changes thoroughly.
- Commit your changes and push the branch to your forked repository.
- Open a pull request on the main repository.
We appreciate your contributions!
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! 🚀