README.md

Surface Editor

"Not replacing developers, but helping developers."

Surface Editor is a code editor built by developers for developers—not an auto-coding tool that churns out Flappy Bird clones. It’s a tool designed specifically to enhance coding efficiency by combining the power of AI with a revolutionary new UI, introducing a whole new way to code.

[ Table of Contents ]

• ABOUT THE PROJECT
  • Built With
  • Contributors
• TO EVERYONE
• TO DEVELOPERS
  • UI Prototype
  • Required Installation
  • Recommended Installation for further development
  • Local Setup
  • Join the development team

[ About the Project ]

BUILT WITH

CONTRIBUTORs

[ To Everyone ]

[ To Developers ]

UI PROTOTYPE

REQUIRED INSTALLATION

RECOMMENDED INSTALLATION for further development

LOCAL SETUP

Instructions to run this application on a local machine

1.Run the whole application in a docker container

• Setup using Docker
  • run docker-compose up -d

OR

2.Run the frontend and backend applications separately

• Setup Frontend Testing Application

  • To Frontend Testing Application Directory cd MAIN
  • To install required modules npm install
  • Run Frontend Testing Application npm start
  • Heading to the Application http://localhost:3000/

• Setup Backend Code Server

  • Download .env file 'https://drive.google.com/file/d/10x2XNaH_Ko8ncjUSoqfYZSdqy3UwZxKG/view?usp=sharing' and move this file under Directory backend_services/code_services (make sure this file to be renamed as '.env')
  • To Backend File Server Directory cd backend_services/code_services
  • To install required modules npm install
  • Run Backend File Server npm start
  • Server will running on http://localhost:8200/ in development mode

JOIN THE DEVELOPMENT TEAM