Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/paramveer-psr/codeify
https://github.com/paramveer-psr/codeify
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/paramveer-psr/codeify
- Owner: Paramveer-psr
- Created: 2024-08-05T09:06:46.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-08-06T08:27:49.000Z (5 months ago)
- Last Synced: 2024-08-06T10:57:11.609Z (5 months ago)
- Language: JavaScript
- Size: 406 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Codeify
Codeify is a powerful code converter that transforms code from one programming language to another. It leverages modern web technologies including Express, Node.js, Vite, and React to deliver a seamless and efficient experience.
## Table of Contents
- [Features](#features)
- [Tech Stack](#tech-stack)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
## Features
- Convert code from one programming language to another
- Supports multiple programming languages
- User-friendly interface
- High-performance conversion process
## Tech Stack
- **Frontend**: React, Vite
- **Backend**: Node.js, Express
## Installation
To get started with Codeify, follow these steps:
1. **Clone the repository**
```bash
git clone https://github.com/your-username/codeify.git
cd codeify
```
2. **Install dependencies**
```bash
# Install server dependencies
cd server
npm install
# Install client dependencies
cd ../client
npm install
```
3. **Set up environment variables**
Create a `.env` file in the `server` directory and add your environment variables. For example:
```bash
PORT=5000
```
4. **Run the application**
```bash
# Start the server
cd server
npm start
# Start the client
cd ../client
npm run dev
```
The application should now be running at `http://localhost:3000`.
## Usage
1. Open your browser and navigate to `http://localhost:3000`.
2. Select the programming language of the code you want to convert.
3. Paste your code into the input area.
4. Select the target programming language.
5. Click "Convert" to see the converted code.
## Contributing
We welcome contributions to Codeify! To contribute:
1. Fork the repository.
2. Create a new branch with your feature or bug fix: `git checkout -b my-feature`.
3. Commit your changes: `git commit -m 'Add my feature'`.
4. Push to the branch: `git push origin my-feature`.
5. Create a pull request.
Please ensure your code adheres to our coding standards and includes appropriate tests.