From 2ccaeb26ab9e69527b75b0f650b6a91ed36f00be Mon Sep 17 00:00:00 2001 From: AlexKHecht Date: Tue, 5 Nov 2024 18:41:08 -0300 Subject: [PATCH 1/2] [docs] add linux recommendation, remove mentions of Windows --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index e026694e..0cd5d640 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# Hello Visitor !! Welcome to the PodCodar WebApp +# Welcome to the PodCodar WebApp! -It's nice to have you here! This project is the web app created by the PodCodar community, it's main objective is to teach good practices of development for our mentees. +We're glad you're here! This web app is a project created by the PodCodar community. Our main goal is to teach our mentees good development practices through hands-on experience. ### Technologies @@ -13,19 +13,19 @@ It's nice to have you here! This project is the web app created by the PodCodar -### Start Project +### Getting Started -To work on this project you have use `yarn` or `bun` as package manager. +To work on this project, use `bun` as your package manager. -> Personal suggestion: use `bun` and be happy. +- Install dependencies using Bun by running the command `bun install`. -- Install dependencies using library bun whit command `bun`. +- Run `bun decrypt` to decrypt the `.env.gpg` file. (It'll require a password. Ask current team members for it.) -- run `bun decrypt` to decrypt the `.env.gpg` file. (ask the password for the current teammembers) +> Note: We strongly recommend running the project on Linux. If you have Windows as your OS, or some other non-GNU/Linux compatible OS, see [🐧 Instalando Linux](https://podcodar.notion.site/Instalando-Linux-d78e8dcd9adf429b9a409b974c0d8fe5) -- now enter a command `bun dev` your project will be running. +- Start the development server with `bun dev`. -- to run de **production** build `bun build && bun start` +- For the **production** build, use `bun build && bun start`. ### Our Wikis @@ -33,7 +33,7 @@ To work on this project you have use `yarn` or `bun` as package manager. - [Engineering Wiki][3] - [BanBan Board][4] -### Let's code with us +### Join Us in Coding ! [2]: https://www.notion.so/podcodar/PodCodar-WebApp-4c1b6a896ebf45b49fed62c28ac45bef [3]: https://www.notion.so/podcodar/Engineering-Wiki-597eb2a7a0534547b1e0f9a2e48d22d2 From 059866ab66088d58a4737f62648645c81d91f9ea Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marco=20Ant=C3=B4nio?= Date: Thu, 19 Dec 2024 23:01:30 -0300 Subject: [PATCH 2/2] fix: board link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0cd5d640..debe44f9 100644 --- a/README.md +++ b/README.md @@ -37,4 +37,4 @@ To work on this project, use `bun` as your package manager. [2]: https://www.notion.so/podcodar/PodCodar-WebApp-4c1b6a896ebf45b49fed62c28ac45bef [3]: https://www.notion.so/podcodar/Engineering-Wiki-597eb2a7a0534547b1e0f9a2e48d22d2 -[4]: https://github.com/orgs/podcodar/projects/4 +[4]: https://github.com/orgs/podcodar/projects/13