mirror of
https://github.com/Unleash/unleash.git
synced 2024-10-28 19:06:12 +01:00
d1efff1173
## About the changes I played with the OpenAI APIs to get some help with spelling and grammars.
34 lines
2.1 KiB
Markdown
34 lines
2.1 KiB
Markdown
---
|
|
title: Developer guide
|
|
---
|
|
|
|
## Introduction {#introduction}
|
|
|
|
This repository consists of two main parts: the backend and frontend of Unleash. The backend is a Node.js application built with TypeScript, while the frontend is a React application also built with TypeScript. You can find code specific to the backend in the `src` lib folder and code specific to the frontend in the `frontend` folder.
|
|
|
|
## Development philosophy
|
|
|
|
The development philosophy at Unleash is centered on delivering high-quality software. We achieve this by following a set of principles that we believe will also make the software easy to maintain and extend, serving as our guide.
|
|
|
|
We believe that the following principles are essential in achieving our goal:
|
|
|
|
* We test our code always
|
|
|
|
Software is difficult. Being a software engineer is about acknowledging our limits, and taking every precaution necessary to avoid introducing bugs. We believe that testing is the best way to achieve this. We test our code always, and prefer automation over manual testing.
|
|
|
|
* We strive to write code that is easy to understand and maintain
|
|
|
|
We believe code is a language. Written code is a way to communicate intent. It's about explaining to the reader what this code does, in the shortest amount of time possible. As such, writing clean code is supremely important to us. We believe that this contributes to keeping our codebase maintainable, and helps us maintain speed in the long run.
|
|
|
|
* We think about solutions before committing
|
|
|
|
We don't jump to implementation immediately. We think about the problem at hand, and try to examine the impact that this solution may have in a multitude of scenarios. As our product core is open source, we need to balance the solutions and avoid implementations that may be cumbersome for our community. The need to improve our paid offering must never come at the cost of our open source offering.
|
|
|
|
### Required reading
|
|
|
|
The following resources should be read before contributing to the project:
|
|
|
|
* [Clean code javascript](https://github.com/ryanmcdermott/clean-code-javascript)
|
|
* [frontend overview](./frontend/overview.md)
|
|
* [backend overview](./backend/overview.md)
|