mirror of
https://github.com/tiennm99/coolify.git
synced 2026-10-14 06:17:36 +00:00
init of v4 🌮
This commit is contained in:
1 parent
e8088e2a70
commit
edd1719431
515 files changed
+12303
-55187
No files matched your search
@@ -1,21 +0,0 @@
|
||||
## Getting Started
|
||||
|
||||
To contribute to `Coolify` development, you'll benefit from knowing the following:
|
||||
|
||||
- **Languages**
|
||||
- [Node.js]() - 📚 [Introduction](https://nodejs.dev/en/learn/introduction-to-nodejs/)
|
||||
- Javascript - 📚 [Learn Javascript](https://learnjavascript.online/)
|
||||
- Typescript - 📚 [Learn@FreecodeCamp](https://www.freecodecamp.org/news/learn-typescript-beginners-guide/)
|
||||
|
||||
- **Framework JS/TS**
|
||||
- [SvelteKit](https://kit.svelte.dev/) - 📚 [Tutorial](https://svelte.dev/tutorial/basics)
|
||||
- [Fastify](https://www.fastify.io/)
|
||||
|
||||
- **Database ORM**
|
||||
- [Prisma.io](https://www.prisma.io/) - 📚 [Quickstart](https://www.prisma.io/docs/getting-started/quickstart)
|
||||
|
||||
- **Docker**
|
||||
- [Docker Engine API](https://docs.docker.com/engine/api/)
|
||||
|
||||
## How to add a new service?
|
||||
You can find all details [here](https://github.com/coollabsio/coolify-community-templates)
|
||||
@@ -1,61 +0,0 @@
|
||||
## Helping with Translations
|
||||
|
||||
All interface translations can be found inside the folder:
|
||||
|
||||
📁 `apps/ui/src/lib/locales`
|
||||
|
||||
> The base and fallback language is 🇬🇧 `en`.
|
||||
|
||||
---
|
||||
|
||||
## 🖐️ Manual First steps
|
||||
|
||||
To start translating to a new language:
|
||||
|
||||
1. create `apps/ui/src/lib/locales/jp.json` (change `jp` to chosen language)
|
||||
2. copy the contents from `apps/ui/src/lib/locales/en.json` to your new json.
|
||||
2. edit `apps/ui/src/lib/translations.ts`
|
||||
* 2.1. add `jp: { lang },` inside `translations:`
|
||||
* 2.2. duplicate the full `en` locale hash inside `loaders:`, change `en` to `jp`(chosen locale)
|
||||
|
||||
Congratulations! You are now ready to start translating
|
||||
|
||||
## 🤖 Automated First Steps
|
||||
|
||||
We can ease the translation using [MoloLab Json Translator](https://github.com/mololab/json-translator):
|
||||
|
||||
```sh
|
||||
# Install Json Tranlator
|
||||
npm i -g @parvineyvazov/json-translator
|
||||
# Run this command to create a new translation:
|
||||
jsontt apps/ui/src/lib/locales/en.json
|
||||
|
||||
# Example Result:
|
||||
jsontt apps/ui/src/lib/locales/en.json
|
||||
? From which source? #ArgosTranslate
|
||||
? From which language? #Automatic
|
||||
? To which language | languages? #Spanish
|
||||
✔ DONE! 287 of 287 translated.
|
||||
All files are created!
|
||||
You can find them in the same folder as the original JSON file.
|
||||
For Spanish --> es.json created.
|
||||
```
|
||||
|
||||
## Currently supported locales
|
||||
|
||||
- [x] en
|
||||
- [x] fr
|
||||
- [x] pt (autogenerated - needs review)
|
||||
- [x] es (autogenerated - needs review)
|
||||
- [x] ko (autogenerated - needs review)
|
||||
|
||||
## ☑️ Todo:
|
||||
|
||||
- [ ] Write a script to
|
||||
- sync missing keys from `en` to other locales;
|
||||
- remove deprecated keys from all non `en` locales;
|
||||
|
||||
- [ ] Sveltekit-i18n instructs to create one locale file per path, maybe we should review that soon.
|
||||
|
||||
- [ ] Improve the aesthetics of `<LocalePicker/>`
|
||||
- [ ] Make selected locale persistent (in session or cookie)
|
||||
@@ -1,10 +0,0 @@
|
||||
### Container based development flow (recommended and the easiest)
|
||||
|
||||
All you need is to
|
||||
|
||||
1. Install [Docker Engine 20.11+](https://docs.docker.com/engine/install/) on your local machine
|
||||
2. Run `pnpm dev:container`.
|
||||
|
||||
It will build the base image for Coolify and start the development server inside Docker.
|
||||
|
||||
All required ports (3000, 3001) will be exposed to your host.
|
||||
@@ -1,2 +0,0 @@
|
||||
### Inside a Docker container
|
||||
# `WIP`
|
||||
@@ -1,19 +0,0 @@
|
||||
### Gitpod
|
||||
|
||||
#### Option 1 - Preferred:
|
||||
|
||||
Follow the same steps as [container based development flow](./Container.md)
|
||||
|
||||
#### Option 2 - Manual setup:
|
||||
|
||||
1. Create a workspace from this repository,
|
||||
1. run `pnpm install && pnpm db:push && pnpm db:seed`
|
||||
1. and then `pnpm dev`.
|
||||
|
||||
All the required dependencies and packages has been configured for you already.
|
||||
|
||||
---
|
||||
|
||||
> Some packages, just `pack` are not installed in this way.
|
||||
You cannot test all the features.
|
||||
Please use the [container based development flow](./Container.md).
|
||||
@@ -1,8 +0,0 @@
|
||||
### Github codespaces
|
||||
|
||||
If you have github codespaces enabled then you can just:
|
||||
|
||||
1. create a codespace and
|
||||
2. run `pnpm dev` to run your the dev environment.
|
||||
|
||||
All the required dependencies and packages has been configured for you already.
|
||||
@@ -1,17 +0,0 @@
|
||||
### Local Machine
|
||||
|
||||
At the moment, Coolify `doesn't support Windows`.
|
||||
|
||||
You must use `Linux` or `MacOS` or consider using Gitpod or Github Codespaces.
|
||||
|
||||
Install all the prerequisites manually to your host system.
|
||||
If you would not like to install anything,
|
||||
I suggest to use the [container based development flow](#container-based-development-flow-easiest).
|
||||
|
||||
- Due to the lock file, this repository is best with [pnpm](https://pnpm.io). I recommend you try and use `pnpm` because it is cool and efficient!
|
||||
- You need to have [Docker Engine](https://docs.docker.com/engine/install/) installed locally.
|
||||
- You need to have [Docker Compose Plugin](https://docs.docker.com/compose/install/compose-plugin/) installed locally.
|
||||
- You need to have [GIT LFS Support](https://git-lfs.github.com/) installed locally.
|
||||
|
||||
Optional:
|
||||
- To test Heroku buildpacks, you need [pack](https://github.com/buildpacks/pack) binary installed locally.
|
||||
@@ -1,2 +0,0 @@
|
||||
### Mac Setup
|
||||
|
||||
@@ -1 +0,0 @@
|
||||
### Mac Setup
|
||||
Reference in new issue
Block a user