How to share your project as a software developer

Sometimes you might what to share your software project or design to people for reviews or to encourage upcoming developers.

Below are some important steps to consider:

1. screen shots
2. project name
3. brief description
4. inspiration (add links if available)
5. what it does
6. how you built it
7. challenges you ran into
8. accomplishments that you're proud of
9. what you learned
10. what's next for the project
11. tech stack (what it's built with)
12. repo, demo or live URL links to try out
13. appreciation to supervisor, mentor, guidance, or team members

Below is a sample and step by step guide:

I'm using my project as a sample for you guys.

1. screen shots

2. project name

   • My portfolio.

3. brief description

   • My portfolio website contains information about me, my projects and contact form.

4. inspiration (add links if available)

   • This project was inspired by my mentor portfolio website, Mr. Wakili Almustapha Abdullahi (https://wakili.netlify.app/)

5. what it does

   • This project shows some of my recent projects to visitors and potential client as a proof to verify my potentials and skills.

6. how you built it

   • The project was built with HTML, CSS and JavaScript for its functionality, it is deployed to GitHub and hosted on Netlify.

7. challenges you ran into.

   • I face some issues hosting this project to Netlify because it was my first time doing so. As a result, I had to do some research on how to host it on Netlify, which required additional time and effort for me to complete.

8. accomplishments that you're proud of

   • I am happy, I was able to host my portfolio website and share the URL to the public, friends and family to go through.

9. what you learned

   • I learnt a lot from this project from being able to use Git and GitHub to hosting my portfolio online for people to see.

10. what's next for the project

    • Adding some functionality with JavaScript and some useful content like, testimonial and downloadable resume.

11. tech stack (what it is built with)

    • HTML, CSS, JS, GIT, GITHUB, Netlify.

12. repo, demo or live URL links to try out

    • GitHub: https://github.com/abdulsalamamtech/
    • Live URL: https://abdulsalamamtech.netlify.app/
    • YouTube Demo:

13. appreciation to supervisor, mentor, guidance, or team members

    • This project was supervised by my mentor Mr. Abdulsalam and Mr. Muhammed, I truly appreciate their support and mentorship, they are the one that motivate me to move out of my comfort zone.

What else?

You are now done with the guide on how to share your project.

• Now follow and use the steps above:
• Push your project to GitHub
• Share your project on LinkedIn
• You can also tag me @abdulsalamamtech on LinkedIn