Skip to content

Latest commit

 

History

History
90 lines (57 loc) · 2.87 KB

readme.md

File metadata and controls

90 lines (57 loc) · 2.87 KB
Raw

AI Code Reviewer

Let AI review your code as a first step to improve your code quality!


PRs welcome made with hearth by Eyevinn Slack

Requirements

  • Node.js v18.0.0 or higher
  • A modern web browser (Chrome, Firefox, Safari, Edge)
  • OpenAI API key

Eyevinn Open Source Cloude mode

If you want to run this project in a cloud environment you can run it as a service on Eyevinn Open Source Cloud. All you need to do is to create a free account and try it out!

Installation / Usage

% npm install

Running the server

To start the server you can run the following command:

% OPENAI_API_KEY=your_api_key npm run dev

or

% OPENAI_API_KEY=your_api_key \
  OPENAI_REVIEW_ASST=openai_asst_id \
  npm start

Frontend is available at http://localhost:8000/ and API docs at http://localhost:8000/api/docs

Running the frontend

To run the frontend you can run the following command:

% npm run dev:app

When both the server and frontend is up and running you can provide a gitHub URL in the GUI and the AI will review the code and provide feedback.

Development

In the src folder you can find the code for the frontend and the server.

The api.ts file is the entry point for the server and contains the routes and the logic for the server.

In the directory /src/app you can find the code for the frontend.

Contributing

See CONTRIBUTING

Support

Join our community on Slack where you can post any questions regarding any of our open source projects. Eyevinn's consulting business can also offer you:

  • Further development of this component
  • Customization and integration of this component into your platform
  • Support and maintenance agreement

Contact sales@eyevinn.se if you are interested.

About Eyevinn Technology

Eyevinn Technology is an independent consultant firm specialized in video and streaming. Independent in a way that we are not commercially tied to any platform or technology vendor. As our way to innovate and push the industry forward we develop proof-of-concepts and tools. The things we learn and the code we write we share with the industry in blogs and by open sourcing the code we have written.

Want to know more about Eyevinn and how it is to work here. Contact us at work@eyevinn.se!