Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/the-best-codes/codequill

Official Repo for CodeQuill - Organize, Edit, and Share your Code Snippets
https://github.com/the-best-codes/codequill

ai artificial-intelligence best-codes bestcodes codequill css database javascript local nextjs nodejs organization organize organizer share storage syntax syntax-highlighting typescript ui

Last synced: about 2 months ago
JSON representation

Official Repo for CodeQuill - Organize, Edit, and Share your Code Snippets

Host: GitHub
URL: https://github.com/the-best-codes/codequill
Owner: The-Best-Codes
License: mit
Created: 2024-07-11T01:35:03.000Z (6 months ago)
Default Branch: main
Last Pushed: 2024-11-10T00:50:21.000Z (about 2 months ago)
Last Synced: 2024-11-10T01:29:18.888Z (about 2 months ago)
Topics: ai, artificial-intelligence, best-codes, bestcodes, codequill, css, database, javascript, local, nextjs, nodejs, organization, organize, organizer, share, storage, syntax, syntax-highlighting, typescript, ui
Language: TypeScript
Homepage:
Size: 1.7 MB
Stars: 4
Watchers: 1
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md

Awesome Lists containing this project

README

# CodeQuill

[![CodeQuill](https://img.shields.io/badge/CodeQuill-Code%20Editor%20and%20Storage-blue)](https://github.com/codingwithkid/codequill)
[![Crowdin](https://badges.crowdin.net/codequill/localized.svg)](https://crowdin.com/project/codequill)

logo

screenshot

## How to install CodeQuill on Linux

Installing CodeQuill on Linux (Ubuntu is preferred) is straightforward.

### Using the installer

Open your terminal (you can usually press CTRL + ALT + T to do this) and paste the following command:

```bash
cd ~ && curl -O https://github.com/The-Best-Codes/codequill/blob/main/codequill_app.sh && bash codequill_app.sh
```

The install should happen automatically.

### Manual installation

1. Open a terminal on your device.

2. Navigate to your home directory:

```
cd ~
```

3. Download the installation script using curl:

```
curl -O https://raw.githubusercontent.com/The-Best-Codes/codequill/main/.device_scripts/codequill.sh
```

4. Make the downloaded script executable:

```
chmod +x codequill.sh
```

5. Run the installation script:

```
./codequill.sh
```

6. Wait for the installation process to complete. The script will install CodeQuill and any necessary dependencies.

7. Once the installation is finished, you should be able to use CodeQuill on your device.

---

CodeQuill is a web-based code editor designed to offer a free, easy, and efficient way to organize, store, edit, and share code snippets directly from your device. Whether you're working on personal projects or simply storing snippets for future reference, CodeQuill provides a seamless experience for managing your code.

## Features

- **Syntax Highlighting:** Enjoy coding with syntax highlighting that supports multiple languages.
- **Code Storage:** Save your snippets in the a local database for easy access anywhere on your network.
- **Share**: Share your code snippets with other devices on your network to easily transfer codes.
- **Comfortable Interface:** The editor is designed to be as intuitive and familiar as possible. The experience should remind you of working in VS Code.
- **AI Support:** CodeQuill uses AI models to help you name your projects, translate them (coming soon), generate code (coming soon), and much more.

### AI Project Name Generator

![AI Project Name Generator](.assets/ai_name_generator.png)

To generate a name for your project, simply click the wand icon in the project name input. By default, the llama-70b model is used to name your project. You can customize this and other behaviors such as the base URL, API key, and more in by creating a `.env` file in the project root.

## Getting Started

### Prerequisites

- Node.js installed on your machine
- A modern web browser

### Installation

1. Clone the repository to your local machine:

```bash
git clone https://github.com/The-Best-Codes/codequill.git
cd codequill
```

2. Install the required dependencies:

```bash
npm install
```

3. Initialize the database:

```bash
node scripts/init-db.js
```

4. Start the development server:

```bash
npm run dev
```

5. Access the CodeQuill interface by opening `http://localhost:3000` in your web browser.

### Building for Production

To deploy CodeQuill for production use:

```bash
npm run build && npm start
```

This command builds the application for optimal performance and starts the production server.

## Contributing

We welcome contributions to CodeQuill! Whether you're looking to fix bugs, add new features, or improve documentation, please feel free to submit a pull request.

## License

CodeQuill is released under the MIT License. See the LICENSE file for more details.

## Support

For support or to report issues, please visit the [issues page](https://github.com/The-Best-Codes/codequill/issues).

Thank you for considering CodeQuill for your coding needs!