Kamran Ahmed
3 years ago
parent
1afe684699
commit
d177a13aa6
5 changed files with 176 additions and 71 deletions
|
After Width: | Height: | Size: 39 KiB |
|
After Width: | Height: | Size: 5.4 KiB |
@ -1,39 +0,0 @@ |
||||
<p align="center"> |
||||
<img src="public/brand.png" height="128"> |
||||
<h2 align="center">roadmap.sh</h2> |
||||
<p align="center">Community driven roadmaps, articles and resources for developers<p> |
||||
<p align="center"> |
||||
<a href="https://roadmap.sh/guides"> |
||||
<img src="https://img.shields.io/badge/-Guides-0a0a0a.svg?style=flat&colorA=0a0a0a" alt="roadmaps" /> |
||||
</a> |
||||
<a href="https://roadmap.sh/roadmaps"> |
||||
<img src="https://img.shields.io/badge/-Roadmaps-0a0a0a.svg?style=flat&colorA=0a0a0a" alt="roadmaps" /> |
||||
</a> |
||||
<a href="./contributing/guide.md"> |
||||
<img src="https://img.shields.io/badge/%E2%9D%A4-Contribute-0a0a0a.svg?style=flat&colorA=0a0a0a" alt="roadmaps" /> |
||||
</a> |
||||
</p> |
||||
</p> |
||||
|
||||
[roadmap.sh](https://roadmap.sh) is the community effort to create knowledge that is approachable for the developers. |
||||
|
||||
The website is built with Next.js, contains roadmaps which are the step by step guides for developers, guides which are the easier to understand explanations on the complex topics. Anyone can contribute to the website by suggesting changes to existing paths, adding learning resources, becoming an author by adding new guides, updating the existing guides. |
||||
|
||||
## Development |
||||
|
||||
Clone the repository, install the dependencies and start the application |
||||
|
||||
```bash |
||||
git clone https://github.com/kamranahmedse/roadmap.sh |
||||
yarn install |
||||
yarn dev |
||||
``` |
||||
|
||||
## Contributions |
||||
|
||||
* Add new Roadmap |
||||
* Suggest changes to existing roadmap |
||||
* Write an article |
||||
* Improve the site's codebase |
||||
* Write tests |
||||
|
||||
@ -1,34 +1,11 @@ |
||||
# Submitting a new roadmap |
||||
## New Roadmap |
||||
|
||||
First of all thank you for considering to contribute to this project. It wouldn't have been possible for us to keep it live without your contributions 🙏 |
||||
Please provide a rough textual roadmap with what you have in mind with an issue and we can take it from there. |
||||
|
||||
> This process will be automated soon. Follow the steps listed below in order to add a new roadmap for now |
||||
|
||||
* Fork this repository |
||||
* If you haven't contributed to this project before then create your author profile |
||||
* Open the file [authors.json](../content/authors.json) |
||||
* Put your preferred `username` |
||||
* Put a profile picture in [authors directory](../public/authors) with the username |
||||
* Create a new directory for the roadmap inside the [roadmaps directory](../content/roadmaps) by following the below steps: |
||||
* Directory name must be `kebab-cased` and prefixed with the incremental number e.g. `6-java-developer` |
||||
* Create a markdown file `6-roadmap-name/0-About/0-Summary.md` inside this directory and write the article detailing the steps required for this path. It doesn't have to be graphic like the other roadmaps; just focus on writing a detailed but approachable textual guide. |
||||
* Create a file `meta.json` inside the roadmap directory with the content below: |
||||
```json |
||||
{ |
||||
"title": "Roadmap Name", |
||||
"description": "Step by step guide to becoming a modern ***", |
||||
"featuredDescription": "Step by step guide to becoming a modern ** in 2021", |
||||
"author": { |
||||
"name": "Your Name", |
||||
"url": "https://twitter.com/twitter" |
||||
}, |
||||
"featured": false, |
||||
"detailed": false, |
||||
"versions": [] |
||||
} |
||||
``` |
||||
* Once done, run the below command: |
||||
```shell |
||||
yarn meta:roadmaps |
||||
``` |
||||
* Commit, push and open a pull request |
||||
## Existing Roadmaps |
||||
|
||||
For the existing roadmaps, please follow the details listed for the nature of contribution: |
||||
|
||||
* **Fixing Typos** — Make your changes in [the roadmap JSON file](/public/project) |
||||
* **Adding or Removing Nodes** — Please open an issue with your suggestion. |
||||
* **Adding Content to Nodes** — Add your content in [the content directory inside the relevant roadmap](/content/roadmaps). |
||||
|
||||
@ -0,0 +1,108 @@ |
||||
 |
||||
|
||||
> Roadmap to becoming a web developer in 2021 |
||||
|
||||
[](http://roadmap.sh) |
||||
[](http://roadmap.sh/guides) |
||||
[](./translations) |
||||
[](https://www.youtube.com/channel/UCA0H2KIWgWTwpTFjSxp0now?sub_confirmation=1) |
||||
|
||||
|
||||
[roadmap.sh](https://roadmap.sh) is a community effort to create roadmaps, guides and other educational content to help guide the developers in picking up the path and guide their learnings. |
||||
|
||||
*** |
||||
|
||||
<p align="center"> |
||||
<sup>Special Announcement:</sup> |
||||
<br> |
||||
<a href="https://www.youtube.com/channel/UCA0H2KIWgWTwpTFjSxp0now?sub_confirmation=1"> |
||||
<img width="70px" src="https://roadmap.sh/sponsors/youtube.svg"> |
||||
</a> |
||||
<br> |
||||
<sub><b>We now have a YouTube Channel</b></sub> |
||||
<br> |
||||
<sub>I plan on covering the roadmaps and put more content there<br><a href="https://www.youtube.com/channel/UCA0H2KIWgWTwpTFjSxp0now?sub_confirmation=1">Subscribe to the channel</a>.</sub> |
||||
</p> |
||||
|
||||
*** |
||||
<h3 align="center"><strong>Purpose of these Roadmaps</strong></h3> |
||||
|
||||
> The purpose of these roadmaps is to give you an idea about the landscape and to guide you if you are confused about what to learn next and not to encourage you to pick what is hip and trendy. You should grow some understanding of why one tool would be better suited for some cases than the other and remember hip and trendy never means best suited for the job. |
||||
|
||||
<h3 align="center"><strong>Note to Beginners</strong></h3> |
||||
|
||||
> These roadmaps cover everything that is there to learn for the paths listed below. Don't feel overwhelmed, you don't need to learn it all in the beginning if you are just getting started. We are working on the beginner versions of these and will [release it soon](https://roadmap.sh) after we are done with the 2021 release of the Backend and DevOps roadmaps. |
||||
|
||||
*** |
||||
|
||||
## Available Roadmaps |
||||
|
||||
Here is the list of available roadmaps with more being actively worked upon. |
||||
|
||||
- [Frontend Roadmap](https://roadmap.sh/frontend) |
||||
- [Backend Roadmap](https://roadmap.sh/backend) |
||||
- [DevOps Roadmap](https://roadmap.sh/devops) |
||||
- [React Roadmap](https://roadmap.sh/react) |
||||
- [Angular Roadmap](https://roadmap.sh/angular) |
||||
- [Android Roadmap](https://roadmap.sh/android) |
||||
- [Python Roadmap](https://roadmap.sh/python) |
||||
- [Go Roadmap](https://roadmap.sh/go) |
||||
- [Java Roadmap](https://roadmap.sh/java) |
||||
- [DBA Roadmap](https://roadmap.sh/dba) |
||||
|
||||
If you think that these can be improved in any way, please do suggest. Also, if you would like to contribute to existing roadmaps or add a new roadmap, please open an issue or reach out to [@kamranahmed](https://twitter.com/kamranahmedse). |
||||
|
||||
## Development |
||||
|
||||
The website is built with Next.js, contains roadmaps which are the step by step guides for developers, guides which are the easier to understand explanations on the complex topics. Anyone can contribute to the website by suggesting changes to existing paths, adding learning resources, becoming an author by adding new guides, updating the existing guides. |
||||
|
||||
Clone the repository, install the dependencies and start the application |
||||
|
||||
```bash |
||||
git clone https://github.com/kamranahmedse/roadmap.sh |
||||
npm install |
||||
npm run dev |
||||
``` |
||||
|
||||
## Contribution |
||||
|
||||
> Have a look at [contribution docs](./CONTRIBUTING.md) for how to update any of the roadmaps |
||||
|
||||
* Add new Roadmap |
||||
* Suggest changes to existing roadmap |
||||
* Improve the site's codebase |
||||
- Write tests |
||||
- Discuss ideas in issues |
||||
- Spread the word |
||||
- Reach out with any feedback [](https://twitter.com/kamranahmedse) |
||||
|
||||
<br> |
||||
<hr> |
||||
<br> |
||||
|
||||
<div align="center"> |
||||
<p> |
||||
<sup> |
||||
<a href="https://github.com/sponsors/kamranahmedse">My open source work is supported by the community</a> |
||||
</sup> |
||||
</p> |
||||
<sup>Special thanks to:</sup> |
||||
<br> |
||||
<p> |
||||
<a href="https://oss.capital"> |
||||
<div> |
||||
<img src="./.github/sponsors/oss-logo.svg" width="300" alt="OSS Capital"> |
||||
</div> |
||||
<div> |
||||
<sup><b>Founded in 2018, OSS Capital is the first and only venture capital platform focused<br>exclusively on supporting early-stage COSS (commercial open source) startup founders.</b></sup> |
||||
</div> |
||||
</a> |
||||
</p> |
||||
</div> |
||||
|
||||
<br> |
||||
|
||||
|
||||
## License |
||||
|
||||
Have a look at the [license file](./LICENSE) for details |
||||
Loading…
Reference in new issue