Skip to content

[docs] Update README.md #180

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
marco-souza merged 2 commits into from
Dec 20, 2024
Merged

[docs] Update README.md #180

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2ccaeb2
[docs] add linux recommendation, remove mentions of Windows
AlexKHecht Nov 5, 2024
059866a
fix: board link
marco-souza Dec 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -13,28 +13,28 @@ It's nice to have you here! This project is the web app created by the PodCodar
<img src="./docs/images/linux.svg" height="30" />
</div>

### 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

- [WebApp wiki page][2]
- [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
[4]: https://github.com/orgs/podcodar/projects/4
[4]: https://github.com/orgs/podcodar/projects/13
Loading