README.md

Journey Book - A Place Where Coders Can Share Their Journey!

Introduction

This project was created for people who are new to open source, people who don't know how to get started with open source, or people who don't know how to contribute to an open source project.

Live Version

Check out the website → Journey Book

Prerequisites

Before installation, please make sure you have already installed the following tools:

• Git
• NodeJs

If you don't want to install these tools and npm packages. After cloning the repo open index.html in your favorite browser.

Installation Steps

1. Fork the project
2. Clone the project
3. Navigate to the project directory cd journey-book
4. Install dependencies with npm install
5. Run npm run dev
6. Visit http://localhost:3000 on your favorite browser.

The browser will automatically refresh, when you make any changes to the files.

How to contribute

To add your journey follow the below steps 👇

• Create a file named using your GitHub username your-github-username.md in the directory journeys, this will ensure it is unique.
• Make sure you add your profile in Data.json file.

Your profile entry should look like 👇

{
  "name": "YOUR_NAME",
  "username": "YOUR_GITHUB_USERNAME",
  "avatar": "https://github.com/YOUR_GITHUB_USERNAME.png"
}

For Example :-

{
  "name": "Adarsh Jaiswal",
  "username": "Adarsh-jaiss",
  "avatar": "https://github.com/Adarsh-jaiss.png"
}

• Add your journey in your your-github-username.md file. You just have start with Introducing your self & share your social media links in that readme file and that will be displayed on our website (if you have not achieved something as of creating the journey currently, As you learn something new you can always update your README file).
• If you want to know what exactly your journey should inculde please refer to → What should I share in my journey?.
• Check out our contribution guidelines for more information.

Documentation:

• What is Journey Book?
• Why We Created this Project!
• Share Your Experience NOW!!!
• What Should My Journey Include?

Support

• Create a GitHub issue for bug reports and feature requests.
• Follow @collab__ for announcements.
• Add a ⭐️ star on GitHub and to support the project!

💪 Thanks to all Contributors

Thanks a lot for spending your time helping Collab Community grow. Thanks a lot! Keep rocking

License

This project is licensed under the terms of the MIT license. © Adarsh Jaiswal