Slanine: AI Assistant

Welcome to Slanine, an advanced AI assistant designed to help you tackle daily problems and tasks with ease. Built with modern web technologies, Slanine leverages powerful AI capabilities to enhance your productivity and streamline your workflows.

📈 GitHub Repository Stats

🌟 Stars	🍴 Forks	🐛 Issues	🔔 Open PRs	🔕 Closed PRs	🛠️ Languages	✅ Contributors

📑 Table of Contents

1. 🎬 What is Slanine?
2. 🔢Github repository stats
3. 🔑Features
4. 🛠️Technologies Used
5. 🔧Installation
6. 💾Docker Setup
7. 📋Prerequisites
   • 💻Clone the repository
   • 🌏 Configure environment variables
   • 💻Build and run the containers
   • 📲Access the application
   • 🚫Terminate the containers
   • 🔒Stop the Containers
   • 🔓Start the containers
   • 💿Docker Volumes
8. 💻Usage
9. ✏️Author
10. 📋This project is now OFFICIALLY accepted for
11. ❤️Contributors
12. 🤝contributing
13. ⭐Stargazers
14. 🔨Forkers
15. 📜License

Features

Slanine offers a variety of features to assist you in your daily tasks, including:

• Post Writing: Generate engaging and well-structured posts for blogs, social media, and more.
• Content Generation: Create high-quality content tailored to your needs.
• Code Review and Improvement: Automatically review your code, suggest improvements, and write code snippets.
• English Checker: Ensure your writing is grammatically correct and stylistically polished.
• Resume Optimization: Optimize your resume to stand out to potential employers.
• Cover Letter Generation: Craft personalized cover letters for job applications.
• And many more: Discover a wide range of tools designed to boost your productivity.

Technologies Used

Slanine is built using the following technologies:

• Next.js: A powerful React framework for building fast and user-friendly web applications.
• PostgreSQL: A robust and reliable relational database system.
• Stripe: A comprehensive suite of APIs for handling payments and subscriptions.
• Drizzle ORM: A flexible ORM for TypeScript and Node.js.
• Gemini AI Flash 1.5: A state-of-the-art AI model for natural language processing and generation.

Installation

To get started with Slanine, follow these steps:

1. Clone the repository:

   git clone https://github.com/yourusername/slanine.git
   cd slanine

2. Install dependencies:

   npm install

3. Set up the environment variables: Create a .env file in the root directory and add your configuration details:

NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=
CLERK_SECRET_KEY=

NEXT_PUBLIC_CLERK_SIGN_IN_URL=/sign-in
NEXT_PUBLIC_CLERK_SIGN_UP_URL=/sign-up

NEXT_PUBLIC_GOOGLE_GEMINI_API_KEY=

NEXT_PUBLIC_DRIZZLE_DB_URL=

UPSTASH_REDIS_REST_URL=
UPSTASH_REDIS_REST_TOKEN=

4. Run the development server:

   npm run dev

5. Open your browser and navigate to http://localhost:3000.

Here’s the README.md written in MDN format:

---

Docker Setup

This project provides a local development environment using Docker and Docker Compose for a Next.js app, PostgreSQL, and Redis.

Prerequisites

Before you begin, ensure you have the following installed:

• Docker
• Docker Compose

1. Clone the Repository

First, clone the repository and navigate into the project directory:

git clone https://github.com/yourusername/slanine.git
cd slanine

2. Configure Environment Variables

Create a .env.local file in the root directory of the project. Add the following environment variables:

NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=<your-clerk-publishable-key>
CLERK_SECRET_KEY=<your-clerk-secret-key>
NEXT_PUBLIC_CLERK_SIGN_IN_URL=/sign-in
NEXT_PUBLIC_CLERK_SIGN_UP_URL=/sign-up
NEXT_PUBLIC_GOOGLE_GEMINI_API_KEY=<your-google-api-key>
NEXT_PUBLIC_DRIZZLE_DB_URL=postgres://user:password@db:5432/mydatabase
UPSTASH_REDIS_REST_URL=<your-upstash-redis-url>
UPSTASH_REDIS_REST_TOKEN=<your-upstash-redis-token>

Ensure these values are updated according to your local or production environment setup.

3. Build and Run the Containers

To build and start the Docker containers, run:

docker-compose up --build

This command will:

• Build the Next.js app image.
• Set up a PostgreSQL database.
• Run both the app and database containers.

4. Access the Application

Once the containers are up and running, access the app and the database:

• App: http://localhost:3000
• PostgreSQL: localhost:5432 (you can access this with a database client, using the credentials defined in the .env.local NEXT_PUBLIC_DRIZZLE_DB_URL)

5. Terminate the Containers

To terminate the running containers, execute:

docker-compose down

This will gracefully stop and remove the containers.

6. Stop the Containers

To stop the running containers, execute:

docker-compose stop

This will gracefully stop the containers.

7. Start the Containers

To start the stop containers, execute:

docker-compose start

This will gracefully start the stop containers.

8. Docker Volumes

This setup uses a Docker volume to persist PostgreSQL data. The postgres_data volume ensures that the database data is retained between container restarts.

Usage

Explore the various features Slanine offers through its intuitive user interface. From generating content to optimizing your resume, Slanine is designed to provide seamless assistance for your daily tasks.

Author

This project is now OFFICIALLY accepted for

Contributors

Contributing

We welcome contributions to Slanine! If you have any ideas, suggestions, or improvements, please feel free to open an issue or submit a pull request.

Read the Contributor's guide carefully before proceeding

Stargazers ❤️

Forkers ❤️

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contact

For any inquiries or support, please contact Rakshit Sisodiya at [email protected].

---

Thank you for using Slanine! We hope it makes your daily tasks easier and more efficient.