OuraCode

A collaborative coding platform where you can code with Aura with your mates.

Table Of Contents

• Table Of Contents
• About The Project
• Built With
• Getting Started
  • Prerequisites
  • Installation
• Contributing
  • Creating A Pull Request
• Raising an issue
• Code of conduct
• License
• Authors
• API Resources

About The Project

Code With Aura

Built With

• ReactJs
• NodeJs
• ExpressJs
• TailwindCss
• Gemini
• Redis via Upstash
• Docker
• ws
• React Bits
• Monaco

Getting Started

Prerequisites

Git is a distributed version control system used for software development. It allows multiple developers to work on the same codebase simultaneously, keeping track of changes and managing versions. It also enables users to revert changes and collaborate more effectively.

NodeJs is a JavaScript runtime, package manager. NodeJS uses V8 JavaScript engine as the JavaScript engine.

Docker Docker is a software platform that allows you to build, test, and deploy applications quickly. Docker packages software into standardized units called containers that have everything the software needs to run including libraries, system tools, code, and runtime. Be sure that you have docker installed.

Redis Upstash Key Gemini Api Key Vite

Installation

This project utilises NodeJS. Install it before running locally

git clone https://github.com/Mahir-o4/OuraCode.git

cd OuraCode

Frontend

cd client

cp .env.example .env

Fill the required fields inside the .env before starting the server

npm install

npm run dev

This will start the vite development server at http://localhost:5173/

Backend

cd server

cp .env.example .env

Fill the required fields inside the .env before starting the server

npm install

docker build -t custom-compiler  .

• If you are working on linux then: Go to- server/src/sockets/roomSocketHandler.ts and look at line 237-238 and 251-252 and replace

const tempDir = path.join(os.tmpdir(), `${Date.now()}-${Math.random()}`)
fs.mkdirSync(tempDir, { recursive: true })

with

const tempDir = path.join("/tmp", `${Date.now()}-${Math.random()}`)
fs.mkdirSync(tempDir)

Bcz the first one is for Windows and the second one is for Linux.

npm run dev

This will start the development server at http://localhost:3000/

Sorry for using Redis as a DB, ik its not a good practice but I did, idk why ;) - Sanjoy

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

• If you have suggestions for adding or removing projects, feel free to open an issue to discuss it

• Please make sure you check your spelling and grammar.

Creating A Pull Request

Wanna contribute to OuraCode ?

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/FeatureName)
3. Commit your Changes (git commit -m 'Add some FeatureName')
4. Push to the Branch (git push origin feature/FeatureName)
5. Open a Pull Request

Raising an issue

If you're experiencing any problems with WasteEasy, please be sure to review our issue template before opening a new issue. The template includes a list of questions and prompts that will help us better understand the issue you're experiencing, and it will ensure that we have all of the necessary information to investigate the problem.

We kindly ask that you provide as much detail as possible when submitting an issue, including steps to reproduce the problem, any error messages that you have seen, and any other relevant information. This will help us to identify and fix the issue more quickly.

Thank you for your cooperation, and we look forward to hearing from you!

Code of conduct

Developers are requested to go through our code of conduct thoroughly to maintain a peaceful environment within our project.

License

OuraCode is licensed under the Apache License 2.0.
You are free to use and contribute, but must provide proper attribution.
Please do not remove the original author’s credit. LICENSE

Authors

• Sanjoy Paul - Sanjoy Paul - OuraCode
• Mahir Ashef - Sk Mahir Ashef - OuraCode