Skip to content

byjit/runable-editor

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Project name

License: GPL v3 TypeScript Next.js tRPC

🚀 Quick Start

Prerequisites

  • Node.js and npm
  • A Turso database account
  • Google OAuth credentials
  • API keys for your preferred AI providers

Installation

  1. Clone the repository

    git clone https://github.com/byjit/mchat.git
    cd mchat
  2. Install dependencies

    npm install
  3. Set up environment variables

    cp .env.example .env

    Fill in your environment variables in .env (see Environment Variables section)

  4. Set up the database

    npm run db:generate
    npm run db:migrate
  5. Start the development server

    npm run dev

    Your application will be running at http://localhost:3000

🔧 Environment Variables

Create a .env file in the root directory with the variables from .env.example

📜 Available Scripts

  • npm run dev - Start development server with Turbo
  • npm run build - Build for production
  • npm run start - Start production server
  • npm run lint - Run ESLint
  • npm run lint:fix - Fix ESLint issues
  • npm run format:check - Check code formatting
  • npm run format:write - Format code with Prettier
  • npm run typecheck - Run TypeScript type checking
  • npm run db:generate - Generate database schema
  • npm run db:migrate - Run database migrations
  • npm run db:push - Push schema changes to database
  • npm run db:studio - Open Drizzle Studio

🤝 Contributing

We welcome contributions from the community! Please read our Contributing Guidelines to get started.

Development Process

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/amazing-feature
  3. Make your changes and add tests
  4. Run the linter and type checker: npm run check
  5. Commit your changes: git commit -m 'feat: add amazing feature'
  6. Push to the branch: git push origin feature/amazing-feature
  7. Open a Pull Request

📄 License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.

🛡️ Security

If you discover a security vulnerability, please read our Security Policy for information on how to report it responsibly.

📞 Support

🎯 Roadmap

  • Implement home page
  • Implement login page
  • Implement agent chat page
  • Implement dashboard page

🙏 Acknowledgments


Made with ❤️ by Prasanjit Dutta

About

Runable assignment

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors