|
1 | 1 | 
|
2 | 2 |
|
3 |
| -# Quickstart |
4 |
| - |
5 |
| -To run this project locally do the following steps: |
6 |
| - |
7 |
| -- [Git clone this repository](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/cloning-a-repository) |
8 |
| -- npm install |
9 |
| -- npm run dev |
| 3 | +# Web Developer Path |
10 | 4 |
|
11 |
| -Our website is live at [WebDevPath](https://webdevpath.co/). |
| 5 | +The **Web Dev Path** project is an attempt to offer mentoring on how to work with a version-controlled project in a team environment. |
12 | 6 |
|
13 |
| -# Web Developer Path |
| 7 | +Currently, we're developing [a platform](https://webdevpath.co/) in [Next.js](https://nextjs.org/). The platform will be a place where to share ideas about web development and where Non-Profit Organizations can get some help for their websites by sharing their project and needs and getting connected to volunteer junior web developers. This is [how](https://github.com/MarianaSouza/web-dev-path/projects/1) things are going on so far. |
14 | 8 |
|
15 |
| -In this repository, you will find content and resources related to the practical steps to land your first job as a web developer. |
| 9 | +If you are a junior web developer looking for some guidance and mentoring, we invite you to join us and start coding our platform. You will learn how to code in a team environment by following [issue's](https://guides.github.com/features/issues/) instructions and submitting your code to our repository through a [PR](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) while guided throughout the entire process. |
16 | 10 |
|
17 |
| -To add content or request a change, please branch out by following these guidelines: |
| 11 | +If you are an experienced and a patient-lovely developer, a true rockstar who wants to mentor juniors, it will be wonderful to have your help to review those PR's, write detailed issues and guide the developers when necessary. |
18 | 12 |
|
19 |
| -- If you are adding a new section, start your branch saying section-course/ + the course and links you are adding, such as: section-course/html-css-freecodecamp. |
20 |
| -- If you are only updating or requesting an update to a section, start your branch with section/ + what you're updating, as per: section/updating-introduction. |
21 |
| -- All the images should be added under the folder images-web-dev-path. |
22 |
| -- The Pull Requests (PR) should follow a similar structure we can see on the picture below, wich includes a brief description of the PR: |
23 | 13 |
|
24 | 14 | <br />
|
25 | 15 |
|
26 |
| - |
| 16 | +# Slack |
27 | 17 |
|
28 |
| -<br /> |
| 18 | +Reach out on [our channel](https://join.slack.com/t/webdevpath/shared_invite/zt-je2zuuja-zlQr2_YpFP_9zuyGcKeYGg)! |
29 | 19 |
|
30 |
| -This is a video that explains a little bit how to start collaborating with the project: |
| 20 | +<br /> |
31 | 21 |
|
32 |
| -[Start Collaborating](https://www.loom.com/share/fbe2c01a963c4885815391d671f35321?fbclid=IwAR1bI2VdRntQhK37dpRI3LS_YPWDmVk-n8yLTYqKlq-v7QP6cNgkaP5Nqe0) |
| 22 | +# Quickstart |
33 | 23 |
|
34 |
| -These are the videos that explain in detail how to branch out and submit a PR: |
| 24 | +To run this project locally do the following steps: |
35 | 25 |
|
36 |
| -- [Branching out from an up to date master](https://www.loom.com/share/77c3bea45d86428a86c897ac3ccaacc4) |
37 |
| -- [Creating the PR with the first commit](https://www.loom.com/share/04e326b873db4af7a4ce86c74183d554) |
38 |
| -- [Fixing the PR title](https://www.loom.com/share/58feae54c4d04a2e908d5fe41dc262e9) |
39 |
| -- [Adding the description and selecting the reviewers](https://www.loom.com/share/bf775cb7503c42129ab5f7715b094c53) |
40 |
| -- [Merging the PR](https://www.loom.com/share/de0eaa9cdcd34d8bac491cd8955f4883) |
| 26 | +- [Git clone this repository](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/cloning-a-repository) |
| 27 | +- Run `npm install` |
| 28 | +- Run `npm run dev` |
| 29 | +- [Branch out](https://git-scm.com/book/en/v2/Git-Branching-Basic-Branching-and-Merging) by following the structure `feature/add-your-branch-name` or `chore/add-your-branch-name` or `fix/add-your-branch-name` and submit your [PR](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) |
41 | 30 |
|
42 | 31 | <br />
|
43 | 32 |
|
44 |
| -## Channels |
| 33 | +# What if I don't know what to do after cloning the repo? |
45 | 34 |
|
46 |
| -- **Slack** |
47 |
| - |
48 |
| - - [Web Dev Path Channel](https://join.slack.com/t/webdevpath/shared_invite/zt-je2zuuja-zlQr2_YpFP_9zuyGcKeYGg) |
| 35 | +Just reach out on [slack](https://join.slack.com/t/webdevpath/shared_invite/zt-je2zuuja-zlQr2_YpFP_9zuyGcKeYGg)! Someone will help you out, we've got you. |
49 | 36 |
|
50 | 37 | <br />
|
51 | 38 |
|
| 39 | +# Resources |
| 40 | + |
| 41 | +Here you will find content and resources related to courses and practical steps to land your first job as a web developer. |
| 42 | + |
52 | 43 | ## Courses and Certifications
|
53 | 44 |
|
54 | 45 | - **Git**
|
|
0 commit comments