- This will be a way to show front-end web development skills, as well as templates or technical guides for concepts learned during coursework with Promineo Tech.
- It will also use the navbar to redirect to existing social media profiles, examples/portfolios, etc.
- Convert HTML/CSS to React structure
- Create "FEWD Basics" one-page PDF
- Whenever possible, remember to include a link to the live demo site in the README file.
- Proving a live demo allows users to test your site/app’s functionality.
- Be sure to include any relevant login credentials or demo accounts.
Styling created using ChatGPT Assistant Chat transcript
- Include a list of the programming languages, frameworks, libraries, and any other tools used in the development process.
- This section can help readers understand the technical details of your project.
- Choose at least two (but not more than five) features of the app that you are most proud of and explain why.
- Include the challenges faced in implementing these features and the solutions you came up with to overcome them.
- You can demonstrate strong problem-solving skills by providing detailed insight into your development process.
- Use a section for code snippets to highlight your best code.
- Include code that demonstrates coding best practices and your technical expertise.
- Use Markdown code snippets instead of screenshots to make it easy for other developers to understand and replicate the code.
- Provide clear instructions on how to install the project on the user's system, including any dependencies or prerequisites that need to be installed.
- Offer clear instructions on how to use the project (e.g. any relevant command-line options and any configuration files or settings).
- Use this section to share guidelines for other developers who want to contribute to the project.
- Share how to submit bug reports, feature requests, and pull requests.
- Include any relevant terms and conditions, as well as any disclaimers or warranties.
- Even though this should be on your main GitHub profile page, you can add your email address, blog URL, or links to your social media profiles here as well.
For other template ideas, check out: https://github.com/Louis3797/awesome-readme-template/tree/main
Use this section to mention useful resources and libraries that you have used in your projects.